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

Version boosted to 2.0.3 #2329

Merged
merged 1 commit into from
Feb 3, 2025
Merged

Version boosted to 2.0.3 #2329

merged 1 commit into from
Feb 3, 2025

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Feb 3, 2025

Summary by Sourcery

Enhancements:

  • Invert the meaning of the roughness parameter in the PlasmaBrightnessContrast and PlasmaShadow augmentations to better align with user expectations.

Copy link
Contributor

sourcery-ai bot commented Feb 3, 2025

Reviewer's Guide by Sourcery

The version of the library was bumped to 2.0.3. The default value of the roughness parameter in PlasmaBrightnessContrast and PlasmaShadow transforms was changed to 3.0, and the description of the parameter was updated to reflect the change. The generate_plasma_pattern function now requires the roughness and random_generator parameters to be passed in.

Class diagram showing changes to PlasmaBrightnessContrast and PlasmaShadow transforms

classDiagram
    class ImageOnlyTransform
    class PlasmaBrightnessContrast {
        +roughness: float
        note for PlasmaBrightnessContrast "roughness default changed from 0.5 to 3.0
Low values (< 1.0): Smoother pattern
Medium values (~2.0): Natural pattern
High values (> 3.0): Rough pattern"
    }
    class PlasmaShadow {
        +roughness: float
        note for PlasmaShadow "roughness default changed from 0.5 to 3.0
Low values (< 1.0): Smoother shadows
Medium values (~2.0): Natural shadows
High values (> 3.0): Rough shadows"
    }
    ImageOnlyTransform <|-- PlasmaBrightnessContrast
    ImageOnlyTransform <|-- PlasmaShadow
Loading

Class diagram showing changes to generate_plasma_pattern function

classDiagram
    class generate_plasma_pattern {
        +target_shape: tuple[int, int]
        +roughness: float
        +random_generator: np.random.Generator
        note for generate_plasma_pattern "Parameters roughness and random_generator
are now required (removed default values)"
    }
Loading

File-Level Changes

Change Details Files
The version of the library was bumped to 2.0.3.
  • Updated the version from 2.0.2 to 2.0.3
pyproject.toml
The default value of the roughness parameter in PlasmaBrightnessContrast and PlasmaShadow transforms was changed to 3.0, and the description of the parameter was updated to reflect the change.
  • Changed the default value of the roughness parameter in PlasmaBrightnessContrast to 3.0.
  • Updated the description of the roughness parameter in PlasmaBrightnessContrast.
  • Changed the default value of the roughness parameter in PlasmaShadow to 3.0.
  • Updated the description of the roughness parameter in PlasmaShadow.
albumentations/augmentations/transforms.py
The generate_plasma_pattern function now requires the roughness and random_generator parameters to be passed in.
  • The generate_plasma_pattern function now requires the roughness parameter to be passed in.
  • The generate_plasma_pattern function now requires the random_generator parameter to be passed in.
albumentations/augmentations/functional.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 @ternaus - I've reviewed your changes - here's some feedback:

Overall Comments:

  • This PR contains breaking changes (removal of default parameters in generate_plasma_pattern) but only bumps the patch version. According to semantic versioning, breaking changes require a major version bump. Please either revert the breaking changes or update to an appropriate version number.
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.

@ternaus ternaus merged commit 2764cb4 into main Feb 3, 2025
14 checks passed
@ternaus ternaus deleted the boost_version branch February 3, 2025 22:46
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