fiftyone.core.odm.mixins

module documentation
(source)

Mixins and helpers for dataset backing documents.

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

Class DatasetMixin Mixin interface for fiftyone.core.odm.document.Document subclasses that are backed by a dataset.
Class NoDatasetMixin Mixin for fiftyone.core.odm.document.SerializableDocument subtypes that are not backed by a dataset.
Function get_default_fields Gets the default fields present on all instances of the given DatasetMixin class.
Variable fod Undocumented
Variable fog Undocumented
Function _add_field_doc Undocumented
Function _delete_field_doc Undocumented
Function _get_db_field Undocumented
Function _get_index_updates Undocumented
Function _parse_paths Undocumented
Function _remove_nested_paths Undocumented
Function _split_path Undocumented
Function _update_field_doc Undocumented
def get_default_fields(cls, include_private=False, use_db_fields=False): (source)

Gets the default fields present on all instances of the given DatasetMixin class.

Parameters
clsthe DatasetMixin class
include_private:Falsewhether to include fields starting with _
use_db_fields:Falsewhether to return database fields rather than user-facing fields, when applicable
Returns
a tuple of field names
fod = (source)

Undocumented

fog = (source)

Undocumented

def _add_field_doc(field_docs, root_doc, field_or_doc): (source)

Undocumented

def _delete_field_doc(field_docs, field_name): (source)

Undocumented

def _get_db_field(field, path): (source)

Undocumented

def _get_index_updates(dataset, paths, new_paths=None): (source)

Undocumented

def _parse_paths(path, new_path): (source)

Undocumented

def _remove_nested_paths(paths): (source)

Undocumented

def _split_path(path): (source)

Undocumented

def _update_field_doc(field_docs, field_name, field): (source)

Undocumented