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

Cleaned up SPatter #2385

Merged
merged 1 commit into from
Mar 5, 2025
Merged

Cleaned up SPatter #2385

merged 1 commit into from
Mar 5, 2025

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Mar 5, 2025

Summary by Sourcery

Refactor the Spatter augmentation to simplify color handling and remove the ability to select multiple modes.

Enhancements:

  • Simplify color handling in Spatter augmentation by using a single color tuple instead of a dictionary or list.
  • Remove the ability to select multiple modes for the Spatter augmentation.

Copy link
Contributor

sourcery-ai bot commented Mar 5, 2025

Reviewer's Guide by Sourcery

The pull request refactors the Spatter transform to simplify its usage and improve code maintainability. It removes the ability to specify multiple modes and streamlines color handling, making the transform easier to use and understand.

Updated class diagram for Spatter transform

classDiagram
    class Spatter {
        -gauss_sigma: tuple[float, float] | float
        -cutout_threshold: tuple[float, float] | float
        -intensity: tuple[float, float] | float
        -mode: Literal["rain", "mud"]
        -color: tuple[int, ...] | None
        +__init__(
            gauss_sigma: tuple[float, float] | float,
            cutout_threshold: tuple[float, float] | float,
            intensity: tuple[float, float] | float,
            mode: Literal["rain", "mud"],
            color: tuple[int, ...] | None,
            p: float
        )
        +apply(
            img: np.ndarray,
            **params: Any
        ) -> np.ndarray
        +get_params_dependent_on_data(
            data: dict[str, Any],
            random_state: np.random.RandomState
        ) -> dict[str, Any]
    }

    class InitSchema {
        -gauss_sigma: NonNegativeFloatRangeType
        -cutout_threshold: ZeroOneRangeType
        -intensity: ZeroOneRangeType
        -mode: Literal["rain", "mud"]
        -color: Sequence[int] | None
        +check_color() Self
    }

    Spatter -- InitSchema : has a
Loading

File-Level Changes

Change Details Files
Simplified the Spatter transform by removing support for multiple modes and complex color configurations, streamlining the color handling process.
  • Removed the ability to specify multiple modes for the Spatter transform, limiting it to a single mode at a time.
  • Simplified color handling by removing dictionary-based color configurations and directly using a tuple for color specification.
  • Consolidated color validation and default color assignment within the check_color validator.
  • Updated the __init__ method to reflect the changes in mode and color parameter types.
  • Modified the get_params_dependent_on_data method to directly use the color attribute without mode-based selection.
albumentations/augmentations/transforms.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:

  • The removal of the Sequence type hint for mode and color seems like a good simplification.
  • Consider adding a brief explanation in the commit message about why the mode and color types were changed.
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 9f1ce7b into main Mar 5, 2025
14 checks passed
@ternaus ternaus deleted the cleanup_spatter branch March 5, 2025 14:18
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