Fix/ragged-batches - Githubissues

dimidagd commented 2 weeks ago

What changes are proposed in this pull request?

Resolves https://github.com/voxel51/fiftyone/issues/4508

[x] No. You can skip the rest of this section.
[ ] Yes. Give a description of this change to be included in the release notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

[ ] App: FiftyOne application changes
[ ] Build: Build and test infrastructure changes
[x] Core: Core fiftyone Python library changes
[x] Documentation: FiftyOne documentation changes
[ ] Other

Summary by CodeRabbit

Improvements
- The transformation process in the app now uses configurable settings for handling ragged batches, making it more flexible for diverse user requirements.

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The recent update to the fiftyone/utils/torch.py file allows the _build_transforms method to dynamically set the ragged_batches parameter based on the provided config.transforms_args configuration. This replaces the previous hardcoded value of True for ragged_batches, enhancing flexibility when handling batch processing in Torch-based models.

Changes

File	Change Summary
`fiftyone/utils/torch.py`	Updated `_build_transforms` method to use `config.transforms_args.get("ragged_batches", True)` instead of hardcoded `True` for `ragged_batches`.

Sequence Diagram(s)

No sequence diagrams are provided because the changes are too focused and straightforward to benefit from visual representation.

Possibly related issues

voxel51/fiftyone#4508: This issue points out the hardcoded logic for ragged_batches and the inability to run batched predictions. The current changes address this by allowing the ragged_batches parameter to be configured dynamically.

Poem

In code where batches used to lag, Now dynamic, no longer a drag. Configs now steer, Transformations clear, Our models march forward, no sag. 🌟🐇

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Please upload report for BASE (fix/ragged-batches@5ced55e). Learn more about missing BASE report.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## fix/ragged-batches #4509 +/- ## ===================================================== Coverage ? 15.99% ===================================================== Files ? 807 Lines ? 89755 Branches ? 1357 ===================================================== Hits ? 14353 Misses ? 75402 Partials ? 0 ``` | [Flag](https://app.codecov.io/gh/voxel51/fiftyone/pull/4509/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=voxel51) | Coverage Δ | | |---|---|---| | [app](https://app.codecov.io/gh/voxel51/fiftyone/pull/4509/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=voxel51) | `15.99% <ø> (?)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=voxel51#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

dimidagd commented 1 week ago

@dimidagd thanks for the PR! I see the issue and agree that users should have the ability to explicitly configure ragged_batches when using custom transforms.

I think it would be best to add a new (optional) ragged_batches parameter rather than pulling it from transforms_args["ragged_batches"], as the latter is supposed to be usable in conjunction with transforms_fcn like this:
transforms = transforms_fcn(**transforms_args)
I'll go ahead and merge this PR into a feature branch so you get credit for your contribution(!) and will follow up with a commit that migrates the new parameter per the above.

This requires changes in other parts of the codebase as I've understood.

brimoor commented 1 week ago