Skip to content
This repository was archived by the owner on Jul 10, 2025. It is now read-only.

Comments

Updated readme to reflect AlbumentationsX#2570

Merged
ternaus merged 1 commit intomainfrom
update_albumentations_to_albumentationsx
Jun 25, 2025
Merged

Updated readme to reflect AlbumentationsX#2570
ternaus merged 1 commit intomainfrom
update_albumentations_to_albumentationsx

Conversation

@ternaus
Copy link
Collaborator

@ternaus ternaus commented Jun 25, 2025

Summary by Sourcery

Update README to mark Albumentations as unmaintained and guide users toward the new AlbumentationsX successor with licensing details, migration instructions, and refreshed links.

Documentation:

  • Add prominent notice that Albumentations is no longer maintained and redirect development to AlbumentationsX
  • Describe two user paths: continue with original (no updates) or upgrade to AlbumentationsX with dual-license details
  • Provide simple migration commands and ensure existing code remains compatible
  • Update documentation and demo links to point to current resources
  • Reorganize sponsorship and partner sections for clarity

@ternaus ternaus requested a review from Copilot June 25, 2025 23:17
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 25, 2025

Reviewer's Guide

This PR overhauls the README to announce the end of maintenance for Albumentations and direct users to the new AlbumentationsX successor—including migration instructions, licensing details and updated support links—while pruning outdated content and reorganizing sponsorship sections, plus a minor update to the rules metadata file.

File-Level Changes

Change Details Files
Deprecation notice and successor migration guide
  • Introduce “Important Notice” deprecation banner
  • Add AlbumentationsX overview with dual-license warning
  • Provide upgrade options and migration commands
  • Include “Learn More” section with repo, pricing, and community links
README.md
Reorganize sponsorship and partner promotions
  • Remove original partner tables and sponsor callouts
  • Reinsert GitAds sponsorship block at bottom
  • Adjust sponsorship call-to-action placement
README.md
Prune outdated sections and update links
  • Remove “use with deep learning frameworks” section and TOC entry
  • Update installation and documentation URLs
  • Replace online demo link
README.md
Minor rules metadata update
  • Apply housekeeping changes to rules file
.cursor/rules/albumentations-rules.mdc

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!

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!


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

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the main README to declare Albumentations end-of-life, introduce the new AlbumentationsX successor, and refresh installation/docs links; it also adds a minor testing guideline in the project rules.

  • Mark repository as unmaintained and point users to AlbumentationsX
  • Provide migration steps, dual‐license warning, and updated links
  • Append a rule in .cursor/rules about placing new tests in the tests folder

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
README.md Adds “no longer maintained” notice, introduces AlbumentationsX and migration guide; updates links and reorders content
.cursor/rules/albumentations-rules.mdc Adds a rule advising new tests be created in the tests folder
Comments suppressed due to low confidence (2)

README.md:46

  • The nested list under 'Dual licensed:' currently uses '- -', which can break markdown rendering. Use two spaces before the dash (i.e. ' - AGPL-3.0: ...') to maintain proper list nesting.
  - **AGPL-3.0**: Free ONLY for projects licensed under AGPL-3.0 (not compatible with MIT, Apache, BSD, etc.)

README.md:36

  • [nitpick] This 'Best for:' line appears unindented under option 1. Indent it to align with the numbered list item so it’s rendered as a sub‐point of '1. Continue Using Albumentations'.
**Best for:** Projects that work fine with the current version and don't need updates

@ternaus ternaus merged commit 66212d7 into main Jun 25, 2025
14 checks passed
@ternaus ternaus deleted the update_albumentations_to_albumentationsx branch June 25, 2025 23:21
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant