fiftyone.core.odm.dataset.DatasetDocument

class documentation

class DatasetDocument(Document): (source)

Constructor: DatasetDocument(**kwargs)

View In Hierarchy

Backing document for datasets.

Method get_annotation_runs Undocumented
Method get_brain_methods Undocumented
Method get_evaluations Undocumented
Method get_runs Undocumented
Method get_saved_views Undocumented
Method get_workspaces Undocumented
Method to_dict Serializes this document to a BSON/JSON dictionary.
Class Variable annotation_runs Undocumented
Class Variable app_config Undocumented
Class Variable brain_methods Undocumented
Class Variable classes Undocumented
Class Variable created_at Undocumented
Class Variable default_classes Undocumented
Class Variable default_group_slice Undocumented
Class Variable default_mask_targets Undocumented
Class Variable default_skeleton Undocumented
Class Variable description Undocumented
Class Variable evaluations Undocumented
Class Variable frame_collection_name Undocumented
Class Variable frame_fields Undocumented
Class Variable group_field Undocumented
Class Variable group_media_types Undocumented
Class Variable info Undocumented
Class Variable mask_targets Undocumented
Class Variable media_type Undocumented
Class Variable meta Undocumented
Class Variable name Undocumented
Class Variable persistent Undocumented
Class Variable runs Undocumented
Class Variable sample_collection_name Undocumented
Class Variable sample_fields Undocumented
Class Variable saved_views Undocumented
Class Variable skeletons Undocumented
Class Variable slug Undocumented
Class Variable tags Undocumented
Class Variable version Undocumented
Class Variable workspaces Undocumented
Instance Variable last_loaded_at Undocumented
Instance Variable last_modified_at Undocumented

Inherited from Document:

Method __init__ Undocumented
Method copy Returns a deep copy of the document.
Method copy_with_new_id Undocumented
Method reload Reloads the document from the database.
Method save Saves the document to the database.
Instance Variable id the ID of the document, or None if it has not been added to the database
Class Method _doc_name Undocumented
Method _deferred_updates Undocumented
Method _do_updates Undocumented
Method _insert Undocumented
Method _parse_changed_fields Undocumented
Method _parse_db_path Undocumented
Method _save Undocumented
Method _update Undocumented
Method _update_last_loaded_at Undocumented
Method _validate Undocumented
Method _validate_updates Undocumented
Instance Variable _changed_fields Undocumented
Instance Variable _created Undocumented

Inherited from BaseDocument (via Document):

Method __eq__ Undocumented
Property in_db Whether the document has been inserted into the database.
Method _get_repr_fields Returns an ordered tuple of field names that should be included in the repr of the document.

Inherited from MongoEngineBaseDocument (via Document, BaseDocument):

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.
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 _to_db_fields Undocumented
Instance Variable _fields_ordered Undocumented

Inherited from SerializableDocument (via Document, BaseDocument, MongoEngineBaseDocument):

Class Method from_json Loads the document from a JSON string.
Method __repr__ Undocumented
Method __str__ Undocumented
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.
def get_annotation_runs(self): (source)

Undocumented

def get_brain_methods(self): (source)

Undocumented

def get_evaluations(self): (source)

Undocumented

def get_runs(self): (source)

Undocumented

def get_saved_views(self): (source)

Undocumented

def get_workspaces(self): (source)

Undocumented

def to_dict(self, *args, no_dereference=False, **kwargs): (source)
overrides fiftyone.core.odm.document.MongoEngineBaseDocument.to_dict

Serializes this document to a BSON/JSON dictionary.

Parameters
*argsUndocumented
no_dereferenceUndocumented
extended:Falsewhether to serialize extended JSON constructs such as ObjectIDs, Binary, etc. into JSON format
**kwargsUndocumented
Returns
a dict
annotation_runs = (source)

Undocumented

app_config = (source)

Undocumented

brain_methods = (source)

Undocumented

classes = (source)

Undocumented

created_at = (source)

Undocumented

default_classes = (source)

Undocumented

default_group_slice = (source)

Undocumented

default_mask_targets = (source)

Undocumented

default_skeleton = (source)

Undocumented

description = (source)

Undocumented

evaluations = (source)

Undocumented

frame_collection_name = (source)

Undocumented

frame_fields = (source)

Undocumented

group_field = (source)

Undocumented

group_media_types = (source)

Undocumented

info = (source)

Undocumented

mask_targets = (source)

Undocumented

media_type = (source)

Undocumented

meta: dict = (source)
overrides fiftyone.core.odm.document.Document.meta

Undocumented

name = (source)

Undocumented

persistent = (source)

Undocumented

runs = (source)

Undocumented

sample_collection_name = (source)

Undocumented

sample_fields = (source)

Undocumented

saved_views = (source)

Undocumented

skeletons = (source)

Undocumented

slug = (source)

Undocumented

tags = (source)

Undocumented

version = (source)

Undocumented

workspaces = (source)

Undocumented

last_loaded_at = (source)
overrides fiftyone.core.odm.document.Document.last_loaded_at

Undocumented

last_modified_at = (source)
overrides fiftyone.core.odm.document.Document.last_modified_at

Undocumented