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

Fix random order #2023

Merged
merged 2 commits into from
Oct 24, 2024
Merged

Fix random order #2023

merged 2 commits into from
Oct 24, 2024

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Oct 24, 2024

Fixes: #2021

Summary by Sourcery

Fix the random order of transformations in the RandomOrder class and enhance its documentation. Update pre-commit configuration to use newer versions of ruff and pyproject-fmt.

Bug Fixes:

  • Fix the random order of transformations in the RandomOrder class to ensure correct application of transforms.

Enhancements:

  • Improve the RandomOrder class by updating its docstring to provide clearer guidance on its usage and attributes.

Build:

  • Update pre-commit configuration to use newer versions of ruff and pyproject-fmt.

Copy link
Contributor

sourcery-ai bot commented Oct 24, 2024

Reviewer's Guide by Sourcery

This PR improves the RandomOrder transform implementation by enhancing its documentation and making the n parameter optional with a default value of 1. The changes also include some minor dependency version updates and type annotation fixes.

Updated class diagram for RandomOrder

classDiagram
    class RandomOrder {
        +TransformsSeqType transforms
        +int n = 1
        +bool replace = False
        +float p = 1.0
        +_get_idx() np.ndarray[np.int_]
    }
    note for RandomOrder "The `n` parameter is now optional with a default value of 1."
    note for RandomOrder "Enhanced documentation for better understanding of attributes."
Loading

File-Level Changes

Change Details Files
Enhanced RandomOrder transform implementation
  • Improved class documentation with detailed explanation of attributes and usage examples
  • Made the 'n' parameter optional with a default value of 1
  • Added comprehensive notes about transform behavior and limitations
albumentations/core/composition.py
Updated development dependencies and configurations
  • Updated ruff-pre-commit from v0.7.0 to v0.7.1
  • Added 'v' prefix to pyproject-fmt version
.pre-commit-config.yaml
Fixed type annotation handling
  • Added type ignore comments for version string type annotation
albumentations/check_version.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.
  • 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
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 and they look great!

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.

Copy link

codecov bot commented Oct 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.35%. Comparing base (b1a79c2) to head (dbd5b9c).
Report is 230 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##           main    #2023       +/-   ##
=========================================
+ Coverage      0   90.35%   +90.35%     
=========================================
  Files         0       47       +47     
  Lines         0     7559     +7559     
=========================================
+ Hits          0     6830     +6830     
- Misses        0      729      +729     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ternaus ternaus merged commit 51c2108 into main Oct 24, 2024
16 checks passed
@ternaus ternaus deleted the fix_random_order branch October 24, 2024 19:51
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.

import RandomOrder
1 participant