search

voxel51 / fiftyone

The open-source tool for building high-quality datasets and computer vision models
https://fiftyone.ai
Apache License 2.0
7.89k stars 518 forks source link

Allow generated datasets to be directly created #4416

Closed brimoor closed 1 month ago

brimoor commented 1 month ago

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

The make_{patches|frames|clips}_dataset() methods were originally designed to be called internally by the to_{patches|frames|clips}() methods but not called directly. For example, as observed in https://github.com/voxel51/fiftyone/issues/4397, they currently return a dataset that behaves like a view in certain ways. Also, directly calling make_clips_dataset() is especially pernicious, as it currently returns a dataset that silently reuses the same frames collection as the input dataset.

However, there is a good use case for directly calling make_{patches|frames|clips}_dataset() to convert a collection into an independent dataset.

So, this PR maintains the behavior of to_{patches|frames|clips}() while tweaking the default behavior of the make_{patches|frames|clips}_dataset() methods so that they do return a completely normal dataset.

Example usage

import fiftyone as fo
import fiftyone.zoo as foz
import fiftyone.core.patches as fop
import fiftyone.core.clips as foc
import fiftyone.core.video as fov
from fiftyone import ViewField as F

#
# Patches dataset
#

dataset = foz.load_zoo_dataset("quickstart")

patches_view = dataset.to_patches("ground_truth")
patches_dataset = fop.make_patches_dataset(dataset, "ground_truth")

assert patches_view._is_generated == True
assert patches_dataset._is_generated == False
assert patches_dataset._sample_collection_name != dataset._sample_collection_name
assert patches_dataset._frame_collection_name is None
assert patches_dataset.count() == patches_view.count()
assert patches_dataset.count() == dataset.count("ground_truth.detections")

#
# Frames dataset
#

dataset = foz.load_zoo_dataset("quickstart-video")

frames_view = dataset.to_frames(sample_frames=True)
frames_dataset = fov.make_frames_dataset(dataset, sample_frames=True)

assert frames_view._is_generated == True
assert frames_dataset._is_generated == False
assert frames_dataset._sample_collection_name != dataset._sample_collection_name
assert frames_dataset._frame_collection_name is None
assert frames_dataset.count() == frames_view.count()
assert frames_dataset.count() == dataset.count("frames")

#
# Clips dataset
#

dataset = foz.load_zoo_dataset("quickstart-video")

expr = F("detections.detections").length() > 10
clips_view = dataset.to_clips(expr)
clips_dataset = foc.make_clips_dataset(dataset, expr)

assert clips_view._is_generated == True
assert clips_dataset._is_generated == False
assert clips_dataset._sample_collection_name != dataset._sample_collection_name
assert clips_dataset._frame_collection_name != dataset._frame_collection_name
assert clips_dataset.count() == clips_view.count()
assert clips_dataset.count("frames") == clips_view.count("frames")

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent updates to the FiftyOne library introduce new parameters persistent and _generated to several dataset creation functions. These parameters enhance dataset management by controlling persistence and generation behavior. Specifically, they allow for creating either temporary or persistent datasets based on the _generated flag. This change affects functions in various modules, including clips.py, dataset.py, patches.py, stages.py, and video.py. Additionally, new tests ensure the correct functionality of these updates.

Changes

File(s) Change Summary
fiftyone/core/clips.py Added persistent and _generated parameters to make_clips_dataset; modified name parameter to _name; adjusted dataset creation logic.
fiftyone/core/dataset.py Corrected a comment related to clips datasets.
fiftyone/core/patches.py Added persistent and _generated parameters to make_patches_dataset and make_evaluation_patches_dataset.
fiftyone/core/stages.py Added _generated parameter to several functions, reordered arguments.
fiftyone/core/video.py Added persistent and _generated parameters to make_frames_dataset; updated function documentation.
tests/unittests/patches_tests.py Added test_make_patches_dataset method to validate patch dataset creation.
tests/unittests/video_tests.py Added test_make_frames_dataset and test_make_clips_dataset methods to validate frames and clips dataset creation.

Assessment against linked issues

Objective Addressed Explanation
Ensure make_frames_dataset creates a Dataset not treated as FramesView (#4397) ❓ The changes include adding parameters to control dataset behavior, but it's unclear if _is_frames issue is resolved.
Validate new parameters in dataset creation functions ✅
Add and verify new test methods for dataset creation ✅

In fields of code where datasets grow,
New flags now guide where data flows.
Persistent paths or temp's embrace,
Each line of code finds its place.
With tests to guard and bugs to chase,
Our codebase shines with added grace.

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.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@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.