Skip to content

Conversation

@ternaus
Copy link
Owner

@ternaus ternaus commented Jan 24, 2025

Summary by Sourcery

Update benchmark script to skip jpeg4py and pillow-simd on macOS, increase default runs to 20, and add citation information to the README.

Build:

  • Skip jpeg4py and pillow-simd libraries during benchmarks on macOS.

Documentation:

  • Add citation information.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 24, 2025

Reviewer's Guide by Sourcery

This pull request updates the benchmark script to exclude jpeg4py and pillow-simd on macOS, increases the number of benchmark runs, adds a citation section to the README, and updates the ruff pre-commit hook.

State diagram for benchmark configuration changes

stateDiagram-v2
    [*] --> Configuration
    Configuration --> DefaultConfig
    DefaultConfig: num_images = 2000
    DefaultConfig: num_runs = 20 (increased from 5)
    DefaultConfig --> LibrarySelection
    LibrarySelection --> MacOSLibs: If macOS
    LibrarySelection --> AllLibs: If other OS
    MacOSLibs: Exclude jpeg4py
    MacOSLibs: Exclude pillow-simd
    AllLibs: Include all libraries
    MacOSLibs --> BenchmarkExecution
    AllLibs --> BenchmarkExecution
    BenchmarkExecution --> [*]
Loading

Flow diagram for updated benchmark library selection process

flowchart TD
    A[Start Library Selection] --> B{Check OS}
    B -->|macOS| C[Filter Libraries]
    B -->|Other OS| D[Use All Libraries]
    C -->|Remove jpeg4py| E[Filtered List 1]
    E -->|Remove pillow-simd| F[Final macOS Libraries]
    D --> G[All Libraries List]
    F --> H[Return Library List]
    G --> H
    H --> I[End]
Loading

File-Level Changes

Change Details Files
Modified the benchmark script to exclude jpeg4py and pillow-simd on macOS.
  • Added a function to get libraries based on the OS.
  • Modified the loop to use the new function to get the libraries to benchmark.
run_benchmarks.sh
Increased the default number of benchmark runs.
  • Changed the default value of NUM_RUNS from 5 to 20.
run_benchmarks.sh
Added a citation section to the README.
  • Added a BibTeX entry for citing the benchmark.
README.md
Updated the ruff pre-commit hook.
  • Updated the ruff version to v0.9.3.
.pre-commit-config.yaml

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 @ternaus - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The citation includes a future year (2025) which may need to be updated to the current or expected publication year.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

@ternaus ternaus merged commit 6d13440 into main Jan 24, 2025
1 check passed
@ternaus ternaus deleted the update branch January 24, 2025 03:20
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.

2 participants