fiftyone.utils.rerun¶
Utilities for working with Rerun.
Classes:
|
Class for storing a rerun data (rrd) file and its associated metadata. |
-
class
fiftyone.utils.rerun.RrdFile(*args, **kwargs)¶ Bases:
fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument,fiftyone.core.labels._HasMediaClass for storing a rerun data (rrd) file and its associated metadata.
- Parameters
filepath (None) – the path to the rrd file
version (None) – the version of the rrd file
Attributes:
A unicode string field.
A unicode string field.
An ordered tuple of the public fields of this document.
Methods:
clean()Hook for doing document level data cleaning (usually validation or assignment) before validation is run.
clear_field(field_name)Clears the field from the document.
copy()Returns a deep copy of the document.
fancy_repr([class_name, select_fields, …])Generates a customizable string representation of the document.
field_to_mongo(field_name)field_to_python(field_name, value)from_dict(d[, extended])Loads the document from a BSON/JSON dictionary.
from_json(s)Loads the document from a JSON string.
get_field(field_name)Gets the field of the document.
Get text score from text query
has_field(field_name)Determines whether the document has a field of the given name.
Returns an iterator over the
(name, value)pairs of the public fields of the document.merge(doc[, merge_lists, merge_dicts, overwrite])Merges the contents of the given document into this document.
set_field(field_name, value[, create])Sets the value of a field of the document.
to_dict([extended])Serializes this document to a BSON/JSON dictionary.
to_json([pretty_print])Serializes the document to a JSON string.
to_mongo(*args, **kwargs)Return as SON data ready for use with MongoDB.
validate([clean])Ensure that all fields’ values are valid and that required fields are present.
Classes:
alias of
mongoengine.base.metaclasses.DocumentMetaclass-
filepath¶ A unicode string field.
- Parameters
description (None) – an optional description
info (None) – an optional info dict
read_only (False) – whether the field is read-only
created_at (None) – the datetime the field was created
-
version¶ A unicode string field.
- Parameters
description (None) – an optional description
info (None) – an optional info dict
read_only (False) – whether the field is read-only
created_at (None) – the datetime the field was created
-
STRICT= False¶
-
clean()¶ Hook for doing document level data cleaning (usually validation or assignment) before validation is run.
Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.
-
clear_field(field_name)¶ Clears the field from the document.
- Parameters
field_name – the field name
- Raises
ValueError – if the field does not exist
-
copy()¶ Returns a deep copy of the document.
- Returns
a
SerializableDocument
-
fancy_repr(class_name=None, select_fields=None, exclude_fields=None, **kwargs)¶ Generates a customizable string representation of the document.
- Parameters
class_name (None) – optional class name to use
select_fields (None) – iterable of field names to restrict to
exclude_fields (None) – iterable of field names to exclude
**kwargs – additional key-value pairs to include in the string representation
- Returns
a string representation of the document
-
property
field_names¶ An ordered tuple of the public fields of this document.
-
field_to_mongo(field_name)¶
-
field_to_python(field_name, value)¶
-
classmethod
from_dict(d, extended=False)¶ Loads the document from a BSON/JSON dictionary.
- Parameters
d – a dictionary
extended (False) – whether the input dictionary may contain serialized extended JSON constructs
- Returns
a
SerializableDocument
-
classmethod
from_json(s)¶ Loads the document from a JSON string.
- Returns
a
SerializableDocument
-
get_field(field_name)¶ Gets the field of the document.
- Parameters
field_name – the field name
- Returns
the field value
- Raises
AttributeError – if the field does not exist
-
get_text_score()¶ Get text score from text query
-
has_field(field_name)¶ Determines whether the document has a field of the given name.
- Parameters
field_name – the field name
- Returns
True/False
-
iter_fields()¶ Returns an iterator over the
(name, value)pairs of the public fields of the document.- Returns
an iterator that emits
(name, value)tuples
-
merge(doc, merge_lists=True, merge_dicts=True, overwrite=True)¶ Merges the contents of the given document into this document.
- Parameters
doc – a
SerializableDocumentof same type as this documentmerge_lists (True) – whether to merge the elements of top-level list fields rather than treating the list as a single value
merge_dicts (True) – whether to recursively merge the contents of top-level dict fields rather than treating the dict as a single value
overwrite (True) – whether to overwrite (True) or skip (False) existing fields
-
my_metaclass¶ alias of
mongoengine.base.metaclasses.DocumentMetaclassMethods:mro()Return a type’s method resolution order.
-
set_field(field_name, value, create=True)¶ Sets the value of a field of the document.
- Parameters
field_name – the field name
value – the field value
create (True) – whether to create the field if it does not exist
- Raises
ValueError – if
field_nameis not an allowed field name or does not exist andcreate == False
-
to_dict(extended=False)¶ Serializes this document to a BSON/JSON dictionary.
- Parameters
extended (False) – whether to serialize extended JSON constructs such as ObjectIDs, Binary, etc. into JSON format
- Returns
a dict
-
to_json(pretty_print=False)¶ Serializes the document to a JSON string.
- Parameters
pretty_print (False) – whether to render the JSON in human readable format with newlines and indentations
- Returns
a JSON string
-
to_mongo(*args, **kwargs)¶ Return as SON data ready for use with MongoDB.
-
validate(clean=True)¶ Ensure that all fields’ values are valid and that required fields are present.
Raises
ValidationErrorif any of the fields’ values are found to be invalid.