Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/over time #509

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Feature/over time #509

wants to merge 10 commits into from

Conversation

blooop
Copy link
Owner

@blooop blooop commented Jan 30, 2025

Summary by Sourcery

Add sample_over_time to the list of benchmark parameters and plot both distance and sample_noise in the sweep.

New Features:

  • Added sample_over_time as a benchmark parameter.

Tests:

  • Updated the test to include sample_over_time and plot both distance and sample_noise.

Copy link
Contributor

sourcery-ai bot commented Jan 30, 2025

Reviewer's Guide by Sourcery

This pull request modifies the example meta to include sample_over_time as a sweepable parameter and updates the result variables to be strings instead of references.

Class diagram showing updated BenchMeta configuration

classDiagram
    class BenchMeta {
        +plot_sweep()
        +sample_over_time
        +float_vars
        +categorical_vars
        +sample_with_repeats
    }
    class ResultVars {
        +distance: string
        +sample_noise: string
    }
    BenchMeta -- ResultVars
    note for ResultVars "Changed from object references to string identifiers"
Loading

Flow diagram showing the updated parameter handling

flowchart LR
    A[Input Parameters] --> B{Parameter Type}
    B -->|Sweep Parameters| C[sample_over_time]
    B -->|Result Variables| D[String Identifiers]
    D --> E[distance]
    D --> F[sample_noise]
    C --> G[Plot Generation]
    E --> G
    F --> G
Loading

File-Level Changes

Change Details Files
Updated the result variables to be strings instead of references.
  • Changed result_vars from [BenchableObject.param.distance] to ["distance", "sample_noise"]
bencher/example/meta/generate_meta.py
Added sample_over_time as a sweepable parameter.
  • Uncommented sample_over_time in the sweep_vars list.
bencher/example/meta/generate_meta.py

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @blooop - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider keeping the strongly-typed parameter references (BenchableObject.param.distance) instead of string literals to maintain type safety and IDE support
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant