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

update compare_results script with required arguments, move tabulate … #3

Merged

Conversation

ayasyrev
Copy link
Contributor

@ayasyrev ayasyrev commented Oct 28, 2024

…dependency

Summary by Sourcery

Enhancements:

  • Update the compare_results script to require specific arguments for input and output directories.

Copy link

sourcery-ai bot commented Oct 28, 2024

Reviewer's Guide by Sourcery

The PR updates the command-line argument format for the benchmark comparison script, changing from positional arguments to explicit named arguments using flags.

Sequence diagram for updated compare_results script execution

sequenceDiagram
    actor User
    participant Script as compare_results Script
    participant System

    User->>Script: Execute script with -r and -o flags
    Script->>System: Read results from OUTPUT_DIR
    Script->>System: Write comparison to OUTPUT_DIR/comparison.csv
    System-->>Script: Acknowledge completion
    Script-->>User: Display completion message
Loading

File-Level Changes

Change Details Files
Updated the benchmark comparison script invocation to use explicit named arguments
  • Changed positional arguments to named arguments with -r for results directory and -o for output file
  • Maintained the same functionality while improving command clarity
run_all.sh

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

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

Overall Comments:

  • The PR title mentions moving a tabulate dependency, but this change is not visible in the provided diff. Please either update the PR title to match the current changes or ensure all relevant changes are included in the PR.
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.

@ayasyrev
Copy link
Contributor Author

ayasyrev commented Oct 28, 2024

When saving results, we use .csv extension, but saving markdown string. May be save it as .md?

@ternaus ternaus merged commit dee7b49 into albumentations-team:main Oct 28, 2024
1 check passed
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