Capped the number of indexes to build per collection

minhtuev commented 1 month ago

What changes are proposed in this pull request?

Added a config var and a check for how many indexes that a user can create per collection

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

Manual test (✅ )
Unit test (✅ )

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

[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
[ ] Documentation: FiftyOne documentation changes
[ ] Other

Summary by CodeRabbit

New Features
- Introduced a configuration option for managing the maximum number of concurrent index operations.
Improvements
- Enhanced logging and error handling for the index creation process, providing better feedback on the status of indexing operations.
Tests
- Added a new test to validate the behavior of the dataset indexing functionality when the maximum number of indexes in progress is reached.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes enhance the indexing functionality in the FiftyOne codebase by adding error handling and logging to manage concurrent index operations. A new configuration parameter allows users to set limits on active index builds, improving performance and resource management. This update ensures users receive clear feedback on index creation status, making the system more robust and user-friendly.

Changes

Files	Change Summary
`fiftyone/core/collections.py`	Enhanced `create_index` method with error handling and logging for concurrent indexing operations.
`tests/unittests/dataset_tests.py`	Introduced a test to validate behavior when the maximum concurrent index limit is reached.

Poem

🐇 In the fields where data plays,
New indexes bloom on sunny days.
With logs and limits to guide the way,
Our work is smoother, come what may!
Hoppity hop, let the builds commence,
In a world of order, we make perfect sense! 🌼📈

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 Configuration 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.

minhtuev commented 1 month ago

Example:

In [7]: dataset.create_index("negative_labels.classifications.confidence")
RuntimeError                              Traceback (most recent call last)
<ipython-input-7-ebe634beef82> in ?()
----> 1 dataset.create_index("negative_labels.classifications.confidence")

~/workspace/fiftyone/fiftyone/core/collections.py in ?(self, field_or_spec, unique, **kwargs)
   9172         num_in_progress = len(
   9173             [index for index in ii.values() if index.get("in_progress")]
   9174         )
   9175         if num_in_progress >= fo.config.max_indexes_in_progress:
-> 9176             raise RuntimeError(
   9177                 "Too many indexes are currently being built; "
   9178                 "please try again later."
   9179             )

RuntimeError: Too many indexes are currently being built; please try again later.

In [8]: dataset.stats(include_indexes=True)
Out[8]:
{'samples_count': 10000000,
 'samples_bytes': 156539929160,
 'samples_size': '145.8GB',
 'indexes_count': 4,
 'indexes_bytes': 231845888,
 'indexes_size': '221.1MB',
 'indexes_in_progress': ['positive_labels.classifications.label',
  'positive_labels.classifications.confidence'],
 'index_bytes': {'id': 130613248,
  'negative_labels.classifications.label': 101224448,
  'positive_labels.classifications.label': 4096,
  'positive_labels.classifications.confidence': 4096},
 'index_sizes': {'id': '124.6MB',
  'negative_labels.classifications.label': '96.5MB',
  'positive_labels.classifications.label': '4.0KB',
  'positive_labels.classifications.confidence': '4.0KB'},
 'total_bytes': 156771775048,
 'total_size': '146.0GB'}

minhtuev commented 1 month ago

@brimoor: should we create a separate branch for this change?

I like the idea that users have more freedom in the SDK compared to the UI, but index creation is an impactful operation so this is one type of guardrail that we can add. As we observe although the method is blocking for long-running index creation users can still circumvent it by breaking and re-running etc :)

minhtuev commented 1 month ago

@brimoor Updated the base branch to feat/index-management which is a feature branch for the index-related changes; we can test on this branch before merging to develop.

minhtuev commented 1 month ago

As discussed offline, we will move the guardrail to the Index Management Panel.

voxel51 / fiftyone