fiftyone.core.odm.embedded_document.EmbeddedDocument

class documentation

class EmbeddedDocument(BaseEmbeddedDocument, mongoengine.EmbeddedDocument): (source)

Known subclasses: fiftyone.core.groups.Group, fiftyone.core.odm.dataset.ColorScheme, fiftyone.core.odm.dataset.DatasetAppConfig, fiftyone.core.odm.dataset.KeypointSkeleton, fiftyone.core.odm.dataset.SampleFieldDocument, fiftyone.core.odm.dataset.SidebarGroupDocument, fiftyone.core.odm.workspace.AppComponent

Constructor: EmbeddedDocument(*args, **kwargs)

View In Hierarchy

Base class for documents that are embedded within other documents and therefore are not stored in their own collection in the database.

Method __init__ Undocumented
Class Variable meta Undocumented

Inherited from MongoEngineBaseDocument (via BaseEmbeddedDocument):

Class Method from_dict Loads the document from a BSON/JSON dictionary.
Method __deepcopy__ Undocumented
Method __delattr__ Undocumented
Method __delitem__ Undocumented
Method clear_field Clears the field from the document.
Method field_to_mongo Undocumented
Method field_to_python Undocumented
Method get_field Gets the field of the document.
Method has_field Determines whether the document has a field of the given name.
Method set_field Sets the value of a field of the document.
Method to_dict Serializes this document to a BSON/JSON dictionary.
Property field_names An ordered tuple of the public fields of this document.
Method _get_field Undocumented
Method _get_field_names Returns an ordered tuple of field names of this document.
Method _get_repr_fields Returns an ordered tuple of field names that should be included in the repr of the document.
Method _to_db_fields Undocumented
Instance Variable _fields_ordered Undocumented

Inherited from SerializableDocument (via BaseEmbeddedDocument, MongoEngineBaseDocument):

Class Method from_json Loads the document from a JSON string.
Method __eq__ Undocumented
Method __repr__ Undocumented
Method __str__ Undocumented
Method copy Returns a deep copy of the document.
Method fancy_repr Generates a customizable string representation of the document.
Method iter_fields Returns an iterator over the (name, value) pairs of the public fields of the document.
Method merge Merges the contents of the given document into this document.
Method to_json Serializes the document to a JSON string.