fiftyone.core.collections

module documentation
(source)

Interface for sample collections.

Copyright 2017-2025, Voxel51, Inc.
voxel51.com

Class SampleCollection Abstract class representing an ordered collection of fiftyone.core.sample.Sample instances in a fiftyone.core.dataset.Dataset.
Class SaveContext Context that saves samples from a collection according to a configurable batching strategy.
Variable aggregation Undocumented
Variable fod Undocumented
Variable foos Undocumented
Variable fos Undocumented
Variable foua Undocumented
Variable foud Undocumented
Variable foue Undocumented
Variable fov Undocumented
Variable logger Undocumented
Variable view_stage Undocumented
Function _add_db_fields_to_schema Undocumented
Function _export Undocumented
Function _finalize_label_fields Undocumented
Function _get_default_frame_label_fields_for_exporter Undocumented
Function _get_default_label_fields_for_exporter Undocumented
Function _get_field_with_type Undocumented
Function _get_fields_with_types Undocumented
Function _get_matching_label_field Undocumented
Function _get_matching_label_fields Undocumented
Function _get_non_none_value Undocumented
Function _get_random_characters Undocumented
Function _handle_existing_dirs Undocumented
Function _handle_id_field Undocumented
Function _handle_id_fields Undocumented
Function _is_glob_pattern Undocumented
Function _iter_label_fields Undocumented
Function _iter_schema_label_fields Undocumented
Function _make_registrar Undocumented
Function _make_set_field_pipeline Undocumented
Function _parse_field_name Undocumented
Function _parse_frame_label_fields Undocumented
Function _parse_frame_labels_field Undocumented
Function _parse_frame_values_dicts Undocumented
Function _parse_label_field Undocumented
Function _parse_values_dict Undocumented
Function _render_expr Undocumented
Function _serialize_value Undocumented
Function _set_terminal_list_field Undocumented
Function _to_label_fields_dict Undocumented
Function _transform_values Undocumented
Function _unwind_values Undocumented
aggregation = (source)

Undocumented

fod = (source)

Undocumented

foos = (source)

Undocumented

fos = (source)

Undocumented

foua = (source)

Undocumented

foud = (source)

Undocumented

foue = (source)

Undocumented

fov = (source)

Undocumented

logger = (source)

Undocumented

view_stage = (source)

Undocumented

def _add_db_fields_to_schema(schema): (source)

Undocumented

def _export(sample_collection, export_dir=None, dataset_type=None, data_path=None, labels_path=None, export_media=None, rel_dir=None, dataset_exporter=None, label_field=None, frame_labels_field=None, overwrite=False, progress=None, **kwargs): (source)

Undocumented

def _finalize_label_fields(label_fields_dict, force_dict): (source)

Undocumented

def _get_default_frame_label_fields_for_exporter(sample_collection, dataset_exporter, allow_coercion=True, required=True): (source)

Undocumented

def _get_default_label_fields_for_exporter(sample_collection, dataset_exporter, allow_coercion=True, required=True): (source)

Undocumented

def _get_field_with_type(media_type, label_schema, label_cls, frames=False, allow_coercion=False): (source)

Undocumented

def _get_fields_with_types(media_type, label_schema, label_cls, frames=False, allow_coercion=False): (source)

Undocumented

def _get_matching_label_field(label_schema, label_type_or_types): (source)

Undocumented

def _get_matching_label_fields(sample_collection, patt, frames=False): (source)

Undocumented

def _get_non_none_value(values, level=0): (source)

Undocumented

def _get_random_characters(n): (source)

Undocumented

def _handle_existing_dirs(dataset_exporter=None, export_dir=None, data_path=None, labels_path=None, export_media=False, overwrite=False): (source)

Undocumented

def _handle_id_field(schema, field_name, include_private=False): (source)

Undocumented

def _handle_id_fields(sample_collection, field_name): (source)

Undocumented

def _is_glob_pattern(s): (source)

Undocumented

def _iter_label_fields(sample_collection): (source)

Undocumented

def _iter_schema_label_fields(schema): (source)

Undocumented

def _make_registrar(): (source)

Undocumented

def _make_set_field_pipeline(sample_collection, field, expr, embedded_root=False, allow_missing=False, new_field=None, context=None): (source)

Undocumented

def _parse_field_name(sample_collection, field_name, auto_unwind, omit_terminal_lists, allow_missing, new_field=None): (source)

Undocumented

def _parse_frame_label_fields(samples, label_field, frame_labels_field): (source)

Undocumented

def _parse_frame_labels_field(sample_collection, frame_labels_field, dataset_exporter=None, allow_coercion=False, force_dict=False, required=False): (source)

Undocumented

def _parse_frame_values_dicts(sample_collection, sample_ids, values): (source)

Undocumented

def _parse_label_field(sample_collection, label_field, dataset_exporter=None, allow_coercion=False, force_dict=False, required=False): (source)

Undocumented

def _parse_values_dict(sample_collection, key_field, values): (source)

Undocumented

def _render_expr(expr, path, embedded_root): (source)

Undocumented

def _serialize_value(field_name, field, value, validate=True): (source)

Undocumented

def _set_terminal_list_field(list_field, subfield, expr, embedded_root): (source)

Undocumented

def _to_label_fields_dict(label_field): (source)

Undocumented

def _transform_values(values, fcn, level=1): (source)

Undocumented

def _unwind_values(values, level=0): (source)

Undocumented