class documentation
class SampleFieldDocument(EmbeddedDocument): (source)
Constructor: SampleFieldDocument(*args, **kwargs)
Description of a sample field.
Class Method | from |
Creates a SampleFieldDocument for a field. |
Method | to |
Creates the fiftyone.core.fields.Field specified by this document. |
Class Variable | db |
Undocumented |
Class Variable | description |
Undocumented |
Class Variable | embedded |
Undocumented |
Class Variable | fields |
Undocumented |
Class Variable | ftype |
Undocumented |
Class Variable | info |
Undocumented |
Class Variable | meta |
Undocumented |
Class Variable | name |
Undocumented |
Class Variable | read |
Undocumented |
Class Variable | subfield |
Undocumented |
Instance Variable | created |
Undocumented |
Class Method | _get |
Undocumented |
Static Method | _get |
Undocumented |
Method | _set |
Undocumented |
Inherited from EmbeddedDocument
:
Method | __init__ |
Undocumented |
Inherited from MongoEngineBaseDocument
(via EmbeddedDocument
, BaseEmbeddedDocument
):
Class Method | from |
Loads the document from a BSON/JSON dictionary. |
Method | __deepcopy__ |
Undocumented |
Method | __delattr__ |
Undocumented |
Method | __delitem__ |
Undocumented |
Method | clear |
Clears the field from the document. |
Method | field |
Undocumented |
Method | field |
Undocumented |
Method | get |
Gets the field of the document. |
Method | has |
Determines whether the document has a field of the given name. |
Method | set |
Sets the value of a field of the document. |
Method | to |
Serializes this document to a BSON/JSON dictionary. |
Property | field |
An ordered tuple of the public fields of this document. |
Method | _get |
Undocumented |
Method | _get |
Returns an ordered tuple of field names of this document. |
Method | _get |
Returns an ordered tuple of field names that should be included in the repr of the document. |
Method | _to |
Undocumented |
Instance Variable | _fields |
Undocumented |
Inherited from SerializableDocument
(via EmbeddedDocument
, BaseEmbeddedDocument
, MongoEngineBaseDocument
):
Class Method | from |
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 |
Generates a customizable string representation of the document. |
Method | iter |
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 |
Serializes the document to a JSON string. |
Creates a SampleFieldDocument
for a field.
Parameters | |
field | a fiftyone.core.fields.Field instance |
Returns | |
a SampleFieldDocument |
Creates the fiftyone.core.fields.Field
specified by this
document.
Returns | |
a fiftyone.core.fields.Field |