module documentation

Dataset views.

Copyright 2017-2025, Voxel51, Inc.

Class DatasetView A view into a fiftyone.core.dataset.Dataset.
Function make_optimized_select_view Returns a view that selects the provided sample IDs that is optimized to reduce the document list as early as possible in the pipeline.
Variable fost Undocumented
Function _discard_nested_leafs Undocumented
Function _filter_embedded_field_schema Undocumented
Function _filter_schema Undocumented
Function _merge_selected_fields Undocumented
Function _parse_excluded_fields Undocumented
Function _parse_selected_fields Undocumented
def make_optimized_select_view(sample_collection, sample_ids, ordered=False, groups=False, flatten=False): (source)

Returns a view that selects the provided sample IDs that is optimized to reduce the document list as early as possible in the pipeline.

Warning

This method deletes any other view stages that reorder/select documents, so the returned view may not respect the order of the documents in the input collection.

Parameters
sample_collectiona fiftyone.core.collections.SampleCollection
sample_idsa sample ID or iterable of sample IDs to select
ordered:Falsewhether to sort the samples in the returned view to match the order of the provided IDs
groups:Falsewhether the IDs are group IDs, not sample IDs
flatten:Falsewhether to flatten group datasets before selecting sample ids
Returns
a DatasetView

Undocumented

def _discard_nested_leafs(paths): (source)

Undocumented

def _filter_embedded_field_schema(field, path, selected_fields, excluded_fields): (source)

Undocumented

def _filter_schema(schema, selected_fields, excluded_fields): (source)

Undocumented

def _merge_selected_fields(selected_fields, sf): (source)

Undocumented

def _parse_excluded_fields(paths): (source)

Undocumented

def _parse_selected_fields(paths): (source)

Undocumented