fiftyone.core.odm.mixins¶

Mixins and helpers for sample backing documents.

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

Classes

`DatasetMixin`	Mixin for concrete `fiftyone.core.odm.document.SampleDocument` subtypes that are backed by a dataset.
`NoDatasetMixin`	Mixin for `fiftyone.core.odm.document.SampleDocument` subtypes that are not backed by a dataset.

Functions

`get_default_fields`(cls[, include_private, …])	Gets the default fields present on all instances of the given `DatasetMixin` class.
`get_field_kwargs`(field)
`get_implied_field_kwargs`(value)
`validate_fields_match`(field_name, field, …)

fiftyone.core.odm.mixins.get_default_fields(cls, include_private=False, include_id=False)¶

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

Parameters

cls – the DatasetMixin class
include_private (False) – whether to include fields that start with _
include_id (False) – whether to include the _id field

Returns

a tuple of field names

class fiftyone.core.odm.mixins.DatasetMixin¶

Bases: object

Mixin for concrete fiftyone.core.odm.document.SampleDocument subtypes that are backed by a dataset.

property collection_name¶

property field_names¶

classmethod get_field_schema(ftype=None, embedded_doc_type=None, include_private=False)¶

Returns a schema dictionary describing the fields of this sample.

If the sample belongs to a dataset, the schema will apply to all samples in the dataset.

Parameters

ftype (None) – an optional field type to which to restrict the returned schema. Must be a subclass of fiftyone.core.fields.Field
embedded_doc_type (None) – an optional embedded document type to which to restrict the returned schema. Must be a subclass of fiftyone.core.odm.BaseEmbeddedDocument
include_private (False) – whether to include fields that start with _ in the returned schema

Returns

a dictionary mapping field names to field types

classmethod merge_field_schema(schema)¶

Merges the field schema into this sample.

Parameters: schema – a dictionary mapping field names to fiftyone.core.fields.Field instances
Raises: ValueError – if a field in the schema is not compliant with an existing field of the same name

has_field(field_name)¶

get_field(field_name)¶

classmethod add_field(field_name, ftype, embedded_doc_type=None, subfield=None)¶

Adds a new field to the sample.

Parameters

field_name – the field name
ftype – the field type to create. Must be a subclass of fiftyone.core.fields.Field
embedded_doc_type (None) – the fiftyone.core.odm.BaseEmbeddedDocument type of the field. Only applicable when ftype is fiftyone.core.fields.EmbeddedDocumentField
subfield (None) – the fiftyone.core.fields.Field type of the contained field. Only applicable when ftype is fiftyone.core.fields.ListField or fiftyone.core.fields.DictField

classmethod add_implied_field(field_name, value)¶

Adds the field to the sample, inferring the field type from the provided value.

Parameters

field_name – the field name
value – the field value

set_field(field_name, value, create=False)¶

clear_field(field_name)¶

class fiftyone.core.odm.mixins.NoDatasetMixin¶

Bases: object

Mixin for fiftyone.core.odm.document.SampleDocument subtypes that are not backed by a dataset.

property id¶

property field_names¶

has_field(field_name)¶

get_field(field_name)¶

set_field(field_name, value, create=False)¶

clear_field(field_name)¶

to_dict(extended=False)¶

classmethod from_dict(d, extended=False)¶

save()¶

Saves the sample to the database.

Because the sample does not belong to a dataset, this method does nothing.

reload()¶

Reloads the sample from the database.

Because the sample does not belong to a dataset, this method does nothing.

delete()¶

Deletes the sample from the database.

Because the sample does not belong to a dataset, this method does nothing.

fiftyone.core.odm.mixins.validate_fields_match(field_name, field, ref_field)¶

fiftyone.core.odm.mixins.get_field_kwargs(field)¶

fiftyone.core.odm.mixins.get_implied_field_kwargs(value)¶