<!-- # hard line break macro for HTML -->

# fiftyone.core.odm.runs

Dataset run documents.

Copyright 2017-2026, Voxel51, Inc.
<br/>
[voxel51.com](https://voxel51.com/)
<br/>
<br/>

**Classes:**

| [`RunDocument`](#fiftyone.core.odm.runs.RunDocument)(\*\*kwargs)   | Backing document for dataset runs.   |
|--------------------------------------------------------------------|--------------------------------------|

### *class* fiftyone.core.odm.runs.RunDocument(\*\*kwargs)

Bases: [`Document`](fiftyone.core.odm.document.md#fiftyone.core.odm.document.Document)

Backing document for dataset runs.

**Attributes:**

| [`dataset_id`](#fiftyone.core.odm.runs.RunDocument.dataset_id)     | An Object ID field.                                                                                                                                          |
|--------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`key`](#fiftyone.core.odm.runs.RunDocument.key)                   | A unicode string field.                                                                                                                                      |
| [`version`](#fiftyone.core.odm.runs.RunDocument.version)           | A unicode string field.                                                                                                                                      |
| [`timestamp`](#fiftyone.core.odm.runs.RunDocument.timestamp)       | A datetime field.                                                                                                                                            |
| [`config`](#fiftyone.core.odm.runs.RunDocument.config)             | A dictionary field that wraps a standard Python dictionary.                                                                                                  |
| [`view_stages`](#fiftyone.core.odm.runs.RunDocument.view_stages)   | A list field that wraps a standard `Field`, allowing multiple instances of the field to be stored as a list in the database.                                 |
| [`results`](#fiftyone.core.odm.runs.RunDocument.results)           | A GridFS storage field.                                                                                                                                      |
| [`results_meta`](#fiftyone.core.odm.runs.RunDocument.results_meta) | Facts that describe `results` — a count, a path — written when the results are saved so a reader can answer for them without pulling the blob out of GridFS. |
| [`STRICT`](#fiftyone.core.odm.runs.RunDocument.STRICT)             |                                                                                                                                                              |
| [`field_names`](#fiftyone.core.odm.runs.RunDocument.field_names)   | An ordered tuple of the public fields of this document.                                                                                                      |
| [`id`](#fiftyone.core.odm.runs.RunDocument.id)                     | A field wrapper around MongoDB's ObjectIds.                                                                                                                  |
| [`in_db`](#fiftyone.core.odm.runs.RunDocument.in_db)               | Whether the document has been inserted into the database.                                                                                                    |
| [`pk`](#fiftyone.core.odm.runs.RunDocument.pk)                     | Get the primary key.                                                                                                                                         |

**Miscellaneous:**

| [`DoesNotExist`](#fiftyone.core.odm.runs.RunDocument.DoesNotExist)                       |    |
|------------------------------------------------------------------------------------------|----|
| [`MultipleObjectsReturned`](#fiftyone.core.odm.runs.RunDocument.MultipleObjectsReturned) |    |

**Methods:**

| [`cascade_save`](#fiftyone.core.odm.runs.RunDocument.cascade_save)(\*\*kwargs)                        | Recursively save any references and generic references on the document.                                                                                                                          |
|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`clean`](#fiftyone.core.odm.runs.RunDocument.clean)()                                                | Hook for doing document level data cleaning (usually validation or assignment) before validation is run.                                                                                         |
| [`clear_field`](#fiftyone.core.odm.runs.RunDocument.clear_field)(field_name)                          | Clears the field from the document.                                                                                                                                                              |
| [`compare_indexes`](#fiftyone.core.odm.runs.RunDocument.compare_indexes)()                            | Compares the indexes defined in MongoEngine with the ones existing in the database.                                                                                                              |
| [`copy`](#fiftyone.core.odm.runs.RunDocument.copy)([new_id])                                          | Returns a deep copy of the document.                                                                                                                                                             |
| [`copy_with_new_id`](#fiftyone.core.odm.runs.RunDocument.copy_with_new_id)()                          |                                                                                                                                                                                                  |
| [`create_index`](#fiftyone.core.odm.runs.RunDocument.create_index)(keys[, background])                | Creates the given indexes if required.                                                                                                                                                           |
| [`delete`](#fiftyone.core.odm.runs.RunDocument.delete)([signal_kwargs])                               | Delete the `Document` from the database.                                                                                                                                                         |
| [`drop_collection`](#fiftyone.core.odm.runs.RunDocument.drop_collection)()                            | Drops the entire collection associated with this `Document` type from the database.                                                                                                              |
| [`ensure_indexes`](#fiftyone.core.odm.runs.RunDocument.ensure_indexes)()                              | Checks the document meta data and ensures all the indexes exist.                                                                                                                                 |
| [`fancy_repr`](#fiftyone.core.odm.runs.RunDocument.fancy_repr)([class_name, select_fields, ...])      | Generates a customizable string representation of the document.                                                                                                                                  |
| [`field_to_mongo`](#fiftyone.core.odm.runs.RunDocument.field_to_mongo)(field_name)                    |                                                                                                                                                                                                  |
| [`field_to_python`](#fiftyone.core.odm.runs.RunDocument.field_to_python)(field_name, value)           |                                                                                                                                                                                                  |
| [`from_dict`](#fiftyone.core.odm.runs.RunDocument.from_dict)(d[, extended])                           | Loads the document from a BSON/JSON dictionary.                                                                                                                                                  |
| [`from_json`](#fiftyone.core.odm.runs.RunDocument.from_json)(s)                                       | Loads the document from a JSON string.                                                                                                                                                           |
| [`get_field`](#fiftyone.core.odm.runs.RunDocument.get_field)(field_name)                              | Gets the field of the document.                                                                                                                                                                  |
| [`get_text_score`](#fiftyone.core.odm.runs.RunDocument.get_text_score)()                              | Get text score from text query                                                                                                                                                                   |
| [`has_field`](#fiftyone.core.odm.runs.RunDocument.has_field)(field_name)                              | Determines whether the document has a field of the given name.                                                                                                                                   |
| [`iter_fields`](#fiftyone.core.odm.runs.RunDocument.iter_fields)()                                    | Returns an iterator over the `(name, value)` pairs of the public fields of the document.                                                                                                         |
| [`list_indexes`](#fiftyone.core.odm.runs.RunDocument.list_indexes)()                                  | Lists all indexes that should be created for the Document collection.                                                                                                                            |
| [`merge`](#fiftyone.core.odm.runs.RunDocument.merge)(doc[, merge_lists, merge_dicts, overwrite])      | Merges the contents of the given document into this document.                                                                                                                                    |
| [`modify`](#fiftyone.core.odm.runs.RunDocument.modify)([query])                                       | Perform an atomic update of the document in the database and reload the document object using updated version.                                                                                   |
| [`register_delete_rule`](#fiftyone.core.odm.runs.RunDocument.register_delete_rule)(document_cls, ...) | This method registers the delete rules to apply when removing this object.                                                                                                                       |
| [`reload`](#fiftyone.core.odm.runs.RunDocument.reload)(\*fields, \*\*kwargs)                          | Reloads the document from the database.                                                                                                                                                          |
| [`save`](#fiftyone.core.odm.runs.RunDocument.save)([upsert, validate, safe])                          | Saves the document to the database.                                                                                                                                                              |
| [`select_related`](#fiftyone.core.odm.runs.RunDocument.select_related)([max_depth])                   | Handles dereferencing of [`DBRef`](https://pymongo.readthedocs.io/en/stable/api/bson/dbref.html#bson.dbref.DBRef) objects to a maximum depth in order to cut down the number queries to mongodb. |
| [`set_field`](#fiftyone.core.odm.runs.RunDocument.set_field)(field_name, value[, create])             | Sets the value of a field of the document.                                                                                                                                                       |
| [`switch_collection`](#fiftyone.core.odm.runs.RunDocument.switch_collection)(collection_name[, ...])  | Temporarily switch the collection for a document instance.                                                                                                                                       |
| [`switch_db`](#fiftyone.core.odm.runs.RunDocument.switch_db)(db_alias[, keep_created])                | Temporarily switch the database for a document instance.                                                                                                                                         |
| [`to_dbref`](#fiftyone.core.odm.runs.RunDocument.to_dbref)()                                          | Returns an instance of [`DBRef`](https://pymongo.readthedocs.io/en/stable/api/bson/dbref.html#bson.dbref.DBRef) useful in `__raw__` queries.                                                     |
| [`to_dict`](#fiftyone.core.odm.runs.RunDocument.to_dict)([extended])                                  | Serializes this document to a BSON/JSON dictionary.                                                                                                                                              |
| [`to_json`](#fiftyone.core.odm.runs.RunDocument.to_json)([pretty_print])                              | Serializes the document to a JSON string.                                                                                                                                                        |
| [`to_mongo`](#fiftyone.core.odm.runs.RunDocument.to_mongo)(\*args, \*\*kwargs)                        | Return as SON data ready for use with MongoDB.                                                                                                                                                   |
| [`update`](#fiftyone.core.odm.runs.RunDocument.update)(\*\*kwargs)                                    | Performs an update on the `Document` A convenience wrapper to `update()`.                                                                                                                        |
| [`validate`](#fiftyone.core.odm.runs.RunDocument.validate)([clean])                                   | Ensure that all fields' values are valid and that required fields are present.                                                                                                                   |

**Classes:**

| [`my_metaclass`](#fiftyone.core.odm.runs.RunDocument.my_metaclass)   |    |
|----------------------------------------------------------------------|----|

#### dataset_id

An Object ID 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

#### key

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

#### timestamp

A datetime 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

#### config

A dictionary field that wraps a standard Python dictionary.

If this field is not set, its default value is `{}`.

* **Parameters:**
  * **field** (*None*) – an optional `Field` instance describing the type
    of the values in the dict
  * **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

#### view_stages

A list field that wraps a standard `Field`, allowing multiple
instances of the field to be stored as a list in the database.

If this field is not set, its default value is `[]`.

* **Parameters:**
  * **field** (*None*) – an optional `Field` instance describing the
    type of the list elements
  * **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

#### results

A GridFS storage field.

#### results_meta

Facts that describe `results` — a count, a path — written when the
results are saved so a reader can answer for them without pulling the
blob out of GridFS.

#### *exception* DoesNotExist

Bases: `DoesNotExist`

**Methods:**

| [`add_note`](#fiftyone.core.odm.runs.RunDocument.DoesNotExist.add_note)(object, /)             | Exception.add_note(note) -- add a note to the exception                         |
|------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
| [`with_traceback`](#fiftyone.core.odm.runs.RunDocument.DoesNotExist.with_traceback)(object, /) | Exception.with_traceback(tb) -- set self._\_traceback_\_ to tb and return self. |

**Attributes:**

| [`args`](#fiftyone.core.odm.runs.RunDocument.DoesNotExist.args)   |    |
|-------------------------------------------------------------------|----|

#### add_note(object,)

Exception.add_note(note) –
add a note to the exception

#### args

#### with_traceback(object,)

Exception.with_traceback(tb) –
set self._\_traceback_\_ to tb and return self.

#### *exception* MultipleObjectsReturned

Bases: `MultipleObjectsReturned`

**Methods:**

| [`add_note`](#fiftyone.core.odm.runs.RunDocument.MultipleObjectsReturned.add_note)(object, /)             | Exception.add_note(note) -- add a note to the exception                         |
|-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
| [`with_traceback`](#fiftyone.core.odm.runs.RunDocument.MultipleObjectsReturned.with_traceback)(object, /) | Exception.with_traceback(tb) -- set self._\_traceback_\_ to tb and return self. |

**Attributes:**

| [`args`](#fiftyone.core.odm.runs.RunDocument.MultipleObjectsReturned.args)   |    |
|------------------------------------------------------------------------------|----|

#### add_note(object,)

Exception.add_note(note) –
add a note to the exception

#### args

#### with_traceback(object,)

Exception.with_traceback(tb) –
set self._\_traceback_\_ to tb and return self.

#### STRICT *= False*

#### cascade_save(\*\*kwargs)

Recursively save any references and generic references on the
document.

#### 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

#### *classmethod* compare_indexes()

Compares the indexes defined in MongoEngine with the ones
existing in the database. Returns any missing/extra indexes.

#### copy(new_id=False)

Returns a deep copy of the document.

* **Parameters:**
  **new_id** (*False*) – whether to generate a new ID for the copied
  document. By default, the ID is left as `None` and will be
  automatically populated when the document is added to the
  database

#### copy_with_new_id()

#### *classmethod* create_index(keys, background=False, \*\*kwargs)

Creates the given indexes if required.

* **Parameters:**
  * **keys** – a single index key or a list of index keys (to
    construct a multi-field index); keys may be prefixed with a **+**
    or a **-** to determine the index ordering
  * **background** – Allows index creation in the background

#### delete(signal_kwargs=None, \*\*write_concern)

Delete the `Document` from the database. This
will only take effect if the document has been previously saved.

* **Parameters:**
  * **signal_kwargs** – (optional) kwargs dictionary to be passed to
    the signal calls.
  * **write_concern** – Extra keyword arguments are passed down which
    will be used as options for the resultant `getLastError` command.
    For example, `save(..., w: 2, fsync: True)` will
    wait until at least two servers have recorded the write and
    will force an fsync on the primary server.

#### *classmethod* drop_collection()

Drops the entire collection associated with this
`Document` type from the database.

Raises `OperationError` if the document has no collection set
(i.g. if it is `abstract`)

#### *classmethod* ensure_indexes()

Checks the document meta data and ensures all the indexes exist.

Global defaults can be set in the meta - see guide/defining-documents

By default, this will get called automatically upon first interaction with the
Document collection (query, save, etc) so unless you disabled `auto_create_index`, you
shouldn’t have to call this manually.

This also gets called upon every call to Document.save if `auto_create_index_on_save` is set to True

If called multiple times, MongoDB will not re-recreate indexes if they exist already

#### NOTE
You can disable automatic index creation by setting
`auto_create_index` to False in the documents meta data

#### 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

#### id

A field wrapper around MongoDB’s ObjectIds.

#### *property* in_db

Whether the document has been inserted into the database.

#### 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

#### *classmethod* list_indexes()

Lists all indexes that should be created for the Document collection.
It includes all the indexes from super- and sub-classes.

Note that it will only return the indexes’ fields, not the indexes’ options

#### merge(doc, merge_lists=True, merge_dicts=True, overwrite=True)

Merges the contents of the given document into this document.

* **Parameters:**
  * **doc** – a `SerializableDocument` of same type as this document
  * **merge_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

#### modify(query=None, \*\*update)

Perform an atomic update of the document in the database and reload
the document object using updated version.

Returns True if the document has been updated or False if the document
in the database doesn’t match the query.

#### NOTE
All unsaved changes that have been made to the document are
rejected if the method returns True.

* **Parameters:**
  * **query** – the update will be performed only if the document in the
    database matches the query
  * **update** – Django-style update keyword arguments

#### my_metaclass

alias of `TopLevelDocumentMetaclass`

#### *property* pk

Get the primary key.

#### *classmethod* register_delete_rule(document_cls, field_name, rule)

This method registers the delete rules to apply when removing this
object.

#### reload(\*fields, \*\*kwargs)

Reloads the document from the database.

* **Parameters:**
  **\*fields** – an optional args list of specific fields to reload

#### save(upsert=False, validate=True, safe=False, \*\*kwargs)

Saves the document to the database.

If the document already exists, it will be updated, otherwise it will
be created.

* **Parameters:**
  * **upsert** (*False*) – whether to insert the document if it has an `id`
    populated but no document with that ID exists in the database
  * **validate** (*True*) – whether to validate the document
  * **safe** (*False*) – whether to `reload()` the document before raising
    any errors
* **Returns:**
  self

#### select_related(max_depth=1)

Handles dereferencing of [`DBRef`](https://pymongo.readthedocs.io/en/stable/api/bson/dbref.html#bson.dbref.DBRef) objects to
a maximum depth in order to cut down the number queries to mongodb.

#### 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_name` is not an allowed field name or does
      not exist and `create == False`

#### switch_collection(collection_name, keep_created=True)

Temporarily switch the collection for a document instance.

Only really useful for archiving off data and calling `save()`:

```default
user = User.objects.get(id=user_id)
user.switch_collection('old-users')
user.save()
```

* **Parameters:**
  * **collection_name** (*str*) – The database alias to use for saving the
    document
  * **keep_created** ([*bool*](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)) – keep self._created value after switching collection, else is reset to True

#### SEE ALSO
Use `switch_db`
if you need to read from another database

#### switch_db(db_alias, keep_created=True)

Temporarily switch the database for a document instance.

Only really useful for archiving off data and calling `save()`:

```default
user = User.objects.get(id=user_id)
user.switch_db('archive-db')
user.save()
```

* **Parameters:**
  * **db_alias** (*str*) – The database alias to use for saving the document
  * **keep_created** ([*bool*](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)) – keep self._created value after switching db, else is reset to True

#### SEE ALSO
Use `switch_collection`
if you need to read from another collection

#### to_dbref()

Returns an instance of [`DBRef`](https://pymongo.readthedocs.io/en/stable/api/bson/dbref.html#bson.dbref.DBRef) useful in
`__raw__` queries.

#### 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.

#### update(\*\*kwargs)

Performs an update on the `Document`
A convenience wrapper to `update()`.

Raises `OperationError` if called on an object that has not yet
been saved.

#### validate(clean=True)

Ensure that all fields’ values are valid and that required fields
are present.

Raises `ValidationError` if any of the fields’ values are found
to be invalid.