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

Protect against infinitely growing content size batcher #4806

Merged
merged 1 commit into from
Sep 17, 2024

Conversation

swheaton
Copy link
Contributor

@swheaton swheaton commented Sep 17, 2024

What changes are proposed in this pull request?

If content size batcher is not getting backpressure properly, it would just keep increasing batch size to infinity. Eventually causing problems.
If some versions were misaligned, this was possible to rear its ugly head in Teams.

Let's just cap the batcher (via max_batch_size) to target_size, which would mean 1 byte per object.

How is this patch tested? If it is not, please explain why.

This is essentially what was happening (fixed backpressure) so let's just prevent it.

import fiftyone as fo

batcher = fo.core.utils.ContentSizeDynamicBatcher(None, init_batch_size=100)

for _ in range(10):
  print(next(batcher))
  batcher.apply_backpressure(100 * 1024)

Before 👎🏼

100
1024
10486
107377
1099540
11259290
115295130
1180622131
12089570621
123797203159
...

After 👍🏼

100
1024
10486
107377
1048576
1048576
...

Summary by CodeRabbit

  • New Features

    • Enhanced batch processing by enforcing a maximum limit on the max_batch_size parameter, improving memory efficiency.
  • Bug Fixes

    • Updated tests to reflect changes in batch processing logic, accommodating larger input sizes and ensuring expected outputs align with new parameters.
  • Documentation

    • Improved readability of test function signatures for better clarity.

@swheaton swheaton requested a review from minhtuev September 17, 2024 03:13
Copy link
Contributor

coderabbitai bot commented Sep 17, 2024

Walkthrough

The changes involve modifications to the __init__ method in a class within the fiftyone/core/utils.py file to enforce a maximum limit on the max_batch_size parameter based on the target_size. Additionally, the test_inexhaustible_content_size_batcher function in the tests/unittests/utils_tests.py file has been updated to reflect a new target_size, along with adjustments to the measurements and expected_batches lists. Formatting changes were also made to improve readability in other test functions.

Changes

File Change Summary
fiftyone/core/utils.py Modified __init__ method to adjust max_batch_size based on target_size.
tests/unittests/utils_tests.py Updated test_inexhaustible_content_size_batcher: changed target_size to 1000, updated measurements and expected_batches. Reformatted test_load_dataset_by_id and test_load_dataset_by_alt_id for readability.

Poem

In the meadow where we play,
Batches grow in a grand display.
With limits set, we hop with glee,
Adjusting sizes, oh so free!
A dance of data, swift and bright,
In our world, all feels just right! 🐇✨


Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between afa8f11 and b31c185.

Files selected for processing (2)
  • fiftyone/core/utils.py (1 hunks)
  • tests/unittests/utils_tests.py (3 hunks)
Additional comments not posted (4)
tests/unittests/utils_tests.py (3)

102-111: Verify the updated behavior of the ContentSizeDynamicBatcher.

The changes to the target_size, measurements, and expected_batches reflect the new expected behavior of the ContentSizeDynamicBatcher with a higher target batch size. The test looks good, but please verify that the updated expected_batches align with the intended behavior of the batcher.


477-479: LGTM!

The changes to the function signature improve readability without altering the test behavior.


504-506: LGTM!

The changes to the function signature improve readability without altering the test behavior.

fiftyone/core/utils.py (1)

1465-1467: Looks good! The added logic to cap max_batch_size is a smart safeguard.

Setting max_batch_size to target_size when it is unset or larger is a good way to prevent the batch size from growing unbounded. This can avoid potential issues stemming from excessive memory usage or version discrepancies.


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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    -- I pushed a fix in commit <commit_id>, please review it.
    -- 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 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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@minhtuev minhtuev left a comment

Choose a reason for hiding this comment

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

Nice!

@swheaton swheaton merged commit cb665e4 into develop Sep 17, 2024
13 of 14 checks passed
@swheaton swheaton deleted the fix/infinite-dyn-batch-sizes branch September 17, 2024 03:37
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.

None yet

2 participants