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

Add library mapping #109

Merged
merged 3 commits into from
Dec 8, 2024
Merged

Add library mapping #109

merged 3 commits into from
Dec 8, 2024

Conversation

ternaus
Copy link
Contributor

@ternaus ternaus commented Dec 8, 2024

Summary by Sourcery

Enhance the documentation with a structured learning path, interactive tools, and migration guides. Update pre-commit hooks to newer versions.

Build:

  • Update pre-commit hooks to use newer versions of ruff-pre-commit and mypy.

Documentation:

  • Revise the documentation to include a new 'Learning Path' section for beginners, intermediate, and advanced users, providing structured guidance on using Albumentations for various computer vision tasks.
  • Update the 'Quick Start Guide' and 'Examples' sections to offer hands-on experience with links to Google Colab for running code examples.
  • Introduce a new interactive tool at explore.albumentations.ai for visual exploration and experimentation with different augmentations.
  • Add a new 'Migration Guides' section to assist users in transitioning from other augmentation libraries to Albumentations, including mapping tables and performance benchmarks.

Copy link
Contributor

sourcery-ai bot commented Dec 8, 2024

Reviewer's Guide by Sourcery

This PR significantly enhances the documentation by adding a comprehensive library mapping guide and restructuring the documentation layout. The changes focus on making it easier for users to migrate from other augmentation libraries (like torchvision and Kornia) to Albumentations, while also improving the overall documentation organization.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Restructured documentation layout and navigation
  • Reorganized sections into Quick Start Guide, Learning Path, and Framework Integration
  • Added clear progression paths for beginners, intermediate, and advanced users
  • Improved navigation structure with better categorization of topics
docs/src/docs/index.md
Added comprehensive library mapping documentation
  • Created detailed mapping tables for torchvision transforms
  • Added mapping tables for Kornia transforms
  • Included performance comparisons between libraries
  • Added code examples for migration scenarios
  • Documented key differences between libraries
docs/src/docs/getting_started/augmentation_mapping.md
Updated FAQ section with migration guidance
  • Added new FAQ entry about migrating from other libraries
  • Removed outdated FAQ about border_mode parameter
  • Enhanced existing FAQ entries with more detailed information
docs/src/docs/faq.md
Updated development tooling
  • Updated ruff pre-commit hook from v0.6.9 to v0.8.2
  • Updated mypy pre-commit hook from v1.11.2 to v1.13.0
.pre-commit-config.yaml

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: 1 issue found
  • 🟢 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.

docs/src/docs/getting_started/augmentation_mapping.md Outdated Show resolved Hide resolved
@ternaus ternaus merged commit e58666b into main Dec 8, 2024
1 check passed
@ternaus ternaus deleted the add_library_mapping branch December 8, 2024 00:36
ternaus added a commit that referenced this pull request Dec 17, 2024
* Added part about albumentations 2 torchvision

* Added doc with pytorch and kornia comparison

* typo fix
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