fiftyone.core.fields.EmbeddedDocumentListField

class documentation

class EmbeddedDocumentListField(mongoengine.fields.EmbeddedDocumentListField, Field): (source)

Constructor: EmbeddedDocumentListField(document_type, description, info, read_only, ...)

View In Hierarchy

A field that stores a list of a given type of fiftyone.core.odm.BaseEmbeddedDocument objects.

Parameters
document_typethe fiftyone.core.odm.BaseEmbeddedDocument type stored in this field
descriptionan optional description
infoan optional info dict
read_onlywhether the field is read-only
created_atthe datetime the field was created
Method __init__ Undocumented
Method __str__ Undocumented
Instance Variable _created_at Undocumented
Instance Variable _description Undocumented
Instance Variable _info Undocumented
Instance Variable _read_only Undocumented

Inherited from Field:

Method copy Returns a copy of the field.
Method description.setter Undocumented
Method info.setter Undocumented
Method read_only.setter Undocumented
Method save Saves any edits to this field's description and info attributes.
Property path The fully-qualified path of this field in the dataset's schema, or None if the field is not associated with a dataset.
Method _set_created_at Undocumented
Method _set_dataset Undocumented
Instance Variable __dataset Undocumented
Instance Variable __path Undocumented
Property _dataset The fiftyone.core.dataset.Dataset that this field belongs to, or None if the field is not associated with a dataset.
def __init__(self, document_type, description=None, info=None, read_only=False, created_at=None, **kwargs): (source)
overrides fiftyone.core.fields.Field.__init__

Undocumented

def __str__(self): (source)
overrides fiftyone.core.fields.Field.__str__

Undocumented

_created_at = (source)
overrides fiftyone.core.fields.Field._created_at

Undocumented

_description = (source)
overrides fiftyone.core.fields.Field._description

Undocumented

_info = (source)
overrides fiftyone.core.fields.Field._info

Undocumented

_read_only = (source)
overrides fiftyone.core.fields.Field._read_only

Undocumented