class documentation

Description of a sample field.

Class Method from_field Creates a SampleFieldDocument for a field.
Method to_field Creates the fiftyone.core.fields.Field specified by this document.
Class Variable db_field Undocumented
Class Variable description Undocumented
Class Variable embedded_doc_type Undocumented
Class Variable fields Undocumented
Class Variable ftype Undocumented
Class Variable info Undocumented
Class Variable meta Undocumented
Class Variable name Undocumented
Class Variable read_only Undocumented
Class Variable subfield Undocumented
Instance Variable created_at Undocumented
Class Method _get_field_documents Undocumented
Static Method _get_attr_repr Undocumented
Method _set_created_at Undocumented

Inherited from EmbeddedDocument:

Method __init__ Undocumented

Inherited from MongoEngineBaseDocument (via EmbeddedDocument, 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 EmbeddedDocument, 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.
@classmethod
def from_field(cls, field): (source)

Creates a SampleFieldDocument for a field.

Parameters
fielda fiftyone.core.fields.Field instance
Returns
a SampleFieldDocument
def to_field(self): (source)

Creates the fiftyone.core.fields.Field specified by this document.

Returns
a fiftyone.core.fields.Field
db_field = (source)

Undocumented

description = (source)

Undocumented

embedded_doc_type = (source)

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented

read_only = (source)

Undocumented

subfield = (source)

Undocumented

created_at = (source)

Undocumented

@classmethod
def _get_field_documents(cls, field): (source)

Undocumented

@staticmethod
def _get_attr_repr(field, attr_name): (source)

Undocumented

def _set_created_at(self, created_at): (source)

Undocumented