add bool to meta results

[blooop]

Summary by Sourcery

Add a boolean result to indicate when sample distance is beyond a set threshold, update the meta generator and plotting routines to include it, and provide documentation examples demonstrating its use.

New Features:

• Introduce a new boolean result variable 'is_far_from_origin' to flag when distance exceeds a threshold

Enhancements:

• Compute and display the boolean result alongside existing metrics in the heatmap text and plot sweep calls
• Extend meta-generation logic to recognize ResultBool parameters

Documentation:

• Add a suite of example notebooks showing meta sweeps with the new boolean result across various input configurations

[sourcery-ai]

Reviewer's Guide

Introduces a new boolean result variable is_far_from_origin in the meta example pipeline, updates the metadata generator to recognize booleans, and adds a suite of example notebooks demonstrating the boolean output across different sweep configurations.

File-Level Changes

Change	Details	Files
Add is_far_from_origin boolean result to BenchableObject	Declared is_far_from_origin as a ResultBool field Computed is_far_from_origin in __call__ using a distance threshold Updated result_hmap text to include the new boolean Added is_far_from_origin to the result_vars list in plot_sweep	bencher/example/meta/example_meta.py
Support ResultBool in metadata generation	Extended the type check to treat ResultBool like other result vars	bencher/example/meta/generate_meta.py
Add example notebooks showcasing the new boolean output	Created example notebooks for all combinations of float and categorical sweeps including is_far_from_origin	docs/reference/Meta/ex_0_float_0_cat.ipynb docs/reference/Meta/ex_0_float_1_cat.ipynb docs/reference/Meta/ex_0_float_2_cat.ipynb docs/reference/Meta/ex_1_float_0_cat.ipynb docs/reference/Meta/ex_1_float_1_cat.ipynb docs/reference/Meta/ex_1_float_2_cat.ipynb docs/reference/Meta/ex_2_float_0_cat.ipynb docs/reference/Meta/ex_2_float_1_cat.ipynb docs/reference/Meta/ex_2_float_2_cat.ipynb docs/reference/Meta/ex_3_float_0_cat.ipynb docs/reference/Meta/ex_3_float_1_cat.ipynb docs/reference/Meta/ex_3_float_2_cat.ipynb

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}