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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Compound indexes for group datasets #3244

Merged
merged 2 commits into from
Jul 1, 2023
Merged

[DOCS] Compound indexes for group datasets #3244

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bc7f94
compound indexes example
benjaminpkane Jun 30, 2023
886a94c
lint
benjaminpkane Jun 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/source/user_guide/app.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,6 +472,30 @@ to index the field or embedded field that you wish to filter by:

session = fo.launch_app(dataset)


For group datasets, a compound index should be added in addition to the
individual field index when using the default `slice` App setting. See
:ref:`Groups in the App <groups-app>` for more information about `slice` mode.

.. code-block:: python
:linenos:

import fiftyone as fo
import fiftyone.zoo as foz

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

# Add field index to optimize ground truth label filters in "group" mode
dataset.create_index("detections.detections.label")

# Add field and group compound index to optimize detection label filters
# in "slice" mode
dataset.create_index(
[("group.name", 1), ("detections.detections.label", 1)]
)

session = fo.launch_app(dataset)

You can use
:meth:`list_indexes() <fiftyone.core.collections.SampleCollection.list_indexes>`
to view the existing indexes on a dataset, and you can use
Expand Down