Add support for materializing views

[brimoor]

Adds a materialize() view stage that materializes the current view into a temporary database collection.

Apply this stage to an expensive view (eg an unindexed filtering operation on a large dataset) if you plan to perform multiple downstream operations on the view.

TODO

• Tests
• Documentation

Example usage

import fiftyone as fo
import fiftyone.zoo as foz
from fiftyone import ViewField as F

dataset = foz.load_zoo_dataset("quickstart")

view = dataset.filter_labels("ground_truth", F("label") == "cat")
materialized_view = view.materialize()

# `materialized_view` contains the same contents as `view`
print(view.count("ground_truth.detections"))
print(materialized_view.count("ground_truth.detections"))

# but it doesn't require aggregation to serve its contents!
fo.pprint(view._pipeline())
fo.pprint(materialized_view._pipeline())

# so downstream tasks like statistics are more efficient
print(view.count_values("ground_truth.detections.label"))
print(materialized_view.count_values("ground_truth.detections.label"))

# Materialized views are fully-compliant with the DatasetView interface, so
# you are free to chain additional view stages as usual
complex_view = materialized_view.shuffle().limit(10).to_patches("ground_truth")
print(complex_view.count_values("ground_truth.label"))

Like other generated views (to_patches(), to_frames(), and to_clips()), materialized views automatically sync changes back to their source dataset:

sample = materialized_view.first()

sample["foo"] = "bar"
sample.save()

assert "foo" in dataset.get_field_schema()
assert dataset[sample.id].foo == "bar"

materialized_view.set_values("has_cats", ["True"] * len(materialized_view))

print(materialized_view.count_values("has_cats"))
print(dataset.count_values("has_cats"))

materialized_view.set_field("has_cats", "False (teehee)").save()

print(materialized_view.count_values("has_cats"))
print(dataset.count_values("has_cats"))

materialized_view.exclude_fields(["foo", "has_cats"]).keep_fields()

assert not dataset.has_field("foo")
assert not materialized_view.has_field("foo")

materialized_view.limit(0).keep()

assert len(materialized_view) == 0
assert len(dataset) == 186

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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.