class documentation
class ReferenceField(mongoengine.fields.ReferenceField, Field): (source)
Constructor: ReferenceField(description, info, read_only, created_at, **kwargs)
A reference field.
| Parameters | |
| document | the fiftyone.core.odm.Document type stored in
this field |
Inherited from Field:
| Method | __init__ |
Undocumented |
| Method | __str__ |
Undocumented |
| Method | copy |
Returns a copy of the field. |
| Method | description |
Undocumented |
| Method | info |
Undocumented |
| Method | read |
Undocumented |
| Method | save |
Saves any edits to this field's description and info attributes. |
| Property | created |
The datetime the field was created. |
| Property | description |
A user-editable description of the field. |
| Property | info |
A user-editable dictionary of information about the field. |
| 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. |
| Property | read |
Whether the field is read-only. |
| Method | _set |
Undocumented |
| Method | _set |
Undocumented |
| Instance Variable | __dataset |
Undocumented |
| Instance Variable | __path |
Undocumented |
| Instance Variable | _created |
Undocumented |
| Instance Variable | _description |
Undocumented |
| Instance Variable | _info |
Undocumented |
| Instance Variable | _read |
Undocumented |
| Property | _dataset |
The fiftyone.core.dataset.Dataset that this field belongs to, or None if the field is not associated with a dataset. |