# fiftyone.utils.eval.base
Base evaluation methods.
Copyright 2017-2026, Voxel51, Inc.
[voxel51.com](https://voxel51.com/)
**Functions:**
| [`get_subset_view`](#fiftyone.utils.eval.base.get_subset_view)(sample_collection, gt_field, ...) | Returns the view into the given collection specified by the subset definition. |
|----------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|
**Classes:**
| [`BaseEvaluationMethodConfig`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig)(\*\*kwargs) | Base class for configuring evaluation methods. |
|----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|
| [`BaseEvaluationMethod`](#fiftyone.utils.eval.base.BaseEvaluationMethod)(config) | Base class for evaluation methods. |
| [`BaseEvaluationResults`](#fiftyone.utils.eval.base.BaseEvaluationResults)(samples, config, eval_key) | Base class for evaluation results. |
| [`BaseClassificationResults`](#fiftyone.utils.eval.base.BaseClassificationResults)(samples, config, ...) | Base class for evaluation results that expose classification metrics like P/R/F1 and confusion matrices. |
### fiftyone.utils.eval.base.get_subset_view(sample_collection, gt_field, subset_def)
Returns the view into the given collection specified by the subset
definition.
Example subset definitions:
```default
# Subset defined by a saved view
subset_def = {
"type": "view",
"view": "night_view",
}
# Subset defined by a sample field value
subset_def = {
"type": "sample",
"field": "timeofday",
"value": "night",
}
# Subset defined by a sample field expression
subset_def = {
"type": "field",
"expr": F("uniqueness") > 0.75,
}
# Subset defined by a label attribute value
subset_def = {
"type": "attribute",
"field": "type",
"value": "sedan",
}
# Subset defined by a label expression
bbox_area = F("bounding_box")[2] * F("bounding_box")[3]
subset_def = {
"type": "attribute",
"expr": (0.05 <= bbox_area) & (bbox_area <= 0.5),
}
# Compound subset defined by a sample field value + sample expression
subset_def = [
{
"type": "field",
"field": "timeofday",
"value": "night",
},
{
"type": "field",
"expr": F("uniqueness") > 0.75,
},
]
# Compound subset defined by a sample field value + label expression
bbox_area = F("bounding_box")[2] * F("bounding_box")[3]
subset_def = [
{
"type": "field",
"field": "timeofday",
"value": "night",
},
{
"type": "attribute",
"expr": (0.05 <= bbox_area) & (bbox_area <= 0.5),
},
]
# Compound subset defined by a saved view + label attribute value
subset_def = [
{
"type": "view",
"view": "night_view",
},
{
"type": "attribute",
"field": "type",
"value": "sedan",
}
]
```
* **Parameters:**
* **sample_collection** – a
[`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **gt_field** – the ground truth field
* **subset_def** – a dict or list of dicts defining the subset. See above for
syntax and examples
* **Returns:**
a [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView)
### *class* fiftyone.utils.eval.base.BaseEvaluationMethodConfig(\*\*kwargs)
Bases: [`EvaluationMethodConfig`](fiftyone.core.evaluation.md#fiftyone.core.evaluation.EvaluationMethodConfig)
Base class for configuring evaluation methods.
* **Parameters:**
* **custom_metrics** (*None*) – an optional list of custom metrics to compute
or dict mapping metric names to kwargs dicts
* **\*\*kwargs** – any leftover keyword arguments after subclasses have done
their parsing
**Methods:**
| [`attributes`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.attributes)() | Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.serialize). |
|-----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| [`base_config_cls`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.base_config_cls)(type) | Returns the config class for the given run type. |
| [`build`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.build)() | Builds the `BaseRun` instance associated with this config. |
| [`builder`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.builder)() | Returns a ConfigBuilder instance for this class. |
| [`copy`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.copy)() | Returns a deep copy of the object. |
| [`custom_attributes`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.custom_attributes)([dynamic, private]) | Returns a customizable list of class attributes. |
| [`default`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.default)() | Returns the default config instance. |
| [`from_dict`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.from_dict)(d) | Constructs a `BaseRunConfig` from a serialized JSON dict representation of it. |
| [`from_json`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.from_json)(path, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON file. |
| [`from_kwargs`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.from_kwargs)(\*\*kwargs) | Constructs a Config object from keyword arguments. |
| [`from_str`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.from_str)(s, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON string. |
| [`get_class_name`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.get_class_name)() | Returns the fully-qualified class name string of this object. |
| [`load_credentials`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.load_credentials)(\*\*kwargs) | Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config. |
| [`load_default`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.load_default)() | Loads the default config instance from file. |
| [`parse_array`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_array)(d, key[, default]) | Parses a raw array attribute. |
| [`parse_bool`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_bool)(d, key[, default]) | Parses a boolean value. |
| [`parse_categorical`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_categorical)(d, key, choices[, default]) | Parses a categorical JSON field, which must take a value from among the given choices. |
| [`parse_dict`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_dict)(d, key[, default]) | Parses a dictionary attribute. |
| [`parse_int`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_int)(d, key[, default]) | Parses an integer attribute. |
| [`parse_mutually_exclusive_fields`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_mutually_exclusive_fields)(fields) | Parses a mutually exclusive dictionary of pre-parsed fields, which must contain exactly one field with a truthy value. |
| [`parse_number`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_number)(d, key[, default]) | Parses a number attribute. |
| [`parse_object`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_object)(d, key, cls[, default]) | Parses an object attribute. |
| [`parse_object_array`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_object_array)(d, key, cls[, default]) | Parses an array of objects. |
| [`parse_object_dict`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_object_dict)(d, key, cls[, default]) | Parses a dictionary whose values are objects. |
| [`parse_path`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_path)(d, key[, default]) | Parses a path attribute. |
| [`parse_raw`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_raw)(d, key[, default]) | Parses a raw (arbitrary) JSON field. |
| [`parse_string`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_string)(d, key[, default]) | Parses a string attribute. |
| [`serialize`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.serialize)([reflective]) | Serializes the object into a dictionary. |
| [`to_str`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.to_str)([pretty_print]) | Returns a string representation of this object. |
| [`validate_all_or_nothing_fields`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.validate_all_or_nothing_fields)(fields) | Validates a dictionary of pre-parsed fields checking that either all or none of the fields have a truthy value. |
| [`write_json`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.write_json)(path[, pretty_print]) | Serializes the object and writes it to disk. |
**Attributes:**
| [`cls`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.cls) | The fully-qualified name of this `BaseRunConfig` class. |
|---------------------------------------------------------------------------|-----------------------------------------------------------|
| [`method`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.method) | The name of the method. |
| [`run_cls`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.run_cls) | The `BaseRun` class associated with this config. |
| [`type`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.type) | The type of run. |
#### attributes()
Returns the list of class attributes that will be serialized by
[`serialize()`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.serialize).
* **Returns:**
a list of attributes
#### *static* base_config_cls(type)
Returns the config class for the given run type.
* **Parameters:**
**type** – a `BaseRunConfig.type`
* **Returns:**
a `BaseRunConfig` subclass
#### build()
Builds the `BaseRun` instance associated with this config.
* **Returns:**
a `BaseRun` instance
#### *classmethod* builder()
Returns a ConfigBuilder instance for this class.
#### *property* cls
The fully-qualified name of this `BaseRunConfig` class.
#### copy()
Returns a deep copy of the object.
* **Returns:**
a Serializable instance
#### custom_attributes(dynamic=False, private=False)
Returns a customizable list of class attributes.
By default, all attributes in vars(self) are returned, minus private
attributes (those starting with “_”).
* **Parameters:**
* **dynamic** – whether to include dynamic properties, e.g., those defined
by getter/setter methods or the `@property` decorator. By
default, this is False
* **private** – whether to include private properties, i.e., those
starting with “_”. By default, this is False
* **Returns:**
a list of class attributes
#### *classmethod* default()
Returns the default config instance.
By default, this method instantiates the class from an empty
dictionary, which will only succeed if all attributes are optional.
Otherwise, subclasses should override this method to provide the
desired default configuration.
#### *classmethod* from_dict(d)
Constructs a `BaseRunConfig` from a serialized JSON dict
representation of it.
* **Parameters:**
**d** – a JSON dict
* **Returns:**
a `BaseRunConfig`
#### *classmethod* from_json(path, \*args, \*\*kwargs)
Constructs a Serializable object from a JSON file.
Subclasses may override this method, but, by default, this method
simply reads the JSON and calls from_dict(), which subclasses must
implement.
* **Parameters:**
* **path** – the path to the JSON file on disk
* **\*args** – optional positional arguments for `self.from_dict()`
* **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
an instance of the Serializable class
#### *classmethod* from_kwargs(\*\*kwargs)
Constructs a Config object from keyword arguments.
* **Parameters:**
**\*\*kwargs** – keyword arguments that define the fields expected by cls
* **Returns:**
an instance of cls
#### *classmethod* from_str(s, \*args, \*\*kwargs)
Constructs a Serializable object from a JSON string.
Subclasses may override this method, but, by default, this method
simply parses the string and calls from_dict(), which subclasses must
implement.
* **Parameters:**
* **s** – a JSON string representation of a Serializable object
* **\*args** – optional positional arguments for `self.from_dict()`
* **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
an instance of the Serializable class
#### *classmethod* get_class_name()
Returns the fully-qualified class name string of this object.
#### load_credentials(\*\*kwargs)
Loads any necessary credentials from the given keyword arguments or
the relevant FiftyOne config.
* **Parameters:**
**\*\*kwargs** – subclass-specific credentials
#### *classmethod* load_default()
Loads the default config instance from file.
Subclasses must implement this method if they intend to support
default instances.
#### *property* method
The name of the method.
#### *static* parse_array(d, key, default=)
Parses a raw array attribute.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **default** – a default list to return if key is not present
* **Returns:**
a list of raw (untouched) values
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_bool(d, key, default=)
Parses a boolean value.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **default** – a default bool to return if key is not present
* **Returns:**
True/False
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_categorical(d, key, choices, default=)
Parses a categorical JSON field, which must take a value from among
the given choices.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **choices** – either an iterable of possible values or an enum-like
class whose attributes define the possible values
* **default** – a default value to return if key is not present
* **Returns:**
the raw (untouched) value of the given field, which is equal to a
value from `choices`
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the key was present in the dictionary but its value
was not an allowed choice, or if no default value was provided
and the key was not found in the dictionary
#### *static* parse_dict(d, key, default=)
Parses a dictionary attribute.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **default** – a default dict to return if key is not present
* **Returns:**
a dictionary
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_int(d, key, default=)
Parses an integer attribute.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **default** – a default integer value to return if key is not present
* **Returns:**
an int
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_mutually_exclusive_fields(fields)
Parses a mutually exclusive dictionary of pre-parsed fields, which
must contain exactly one field with a truthy value.
* **Parameters:**
**fields** – a dictionary of pre-parsed fields
* **Returns:**
the (field, value) that was set
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if zero or more than one truthy value was found
#### *static* parse_number(d, key, default=)
Parses a number attribute.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **default** – a default numeric value to return if key is not present
* **Returns:**
a number (e.g. int, float)
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_object(d, key, cls, default=)
Parses an object attribute.
The value of d[key] can be either an instance of cls or a serialized
dict from an instance of cls.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **cls** – the class of d[key]
* **default** – a default cls instance to return if key is not present
* **Returns:**
an instance of cls
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_object_array(d, key, cls, default=)
Parses an array of objects.
The values in d[key] can be either instances of cls or serialized
dicts from instances of cls.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **cls** – the class of the elements of list d[key]
* **default** – the default list to return if key is not present
* **Returns:**
a list of cls instances
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_object_dict(d, key, cls, default=)
Parses a dictionary whose values are objects.
The values in d[key] can be either instances of cls or serialized
dicts from instances of cls.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **cls** – the class of the values of dictionary d[key]
* **default** – the default dict of cls instances to return if key is not
present
* **Returns:**
a dictionary whose values are cls instances
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_path(d, key, default=)
Parses a path attribute.
The path is converted to an absolute path if necessary via
`os.path.abspath(os.path.expanduser(value))`.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **default** – a default string to return if key is not present
* **Returns:**
a path string
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_raw(d, key, default=)
Parses a raw (arbitrary) JSON field.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **default** – a default value to return if key is not present
* **Returns:**
the raw (untouched) value of the given field
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if no default value was provided and the key was not
found in the dictionary
#### *static* parse_string(d, key, default=)
Parses a string attribute.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **default** – a default string to return if key is not present
* **Returns:**
a string
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *property* run_cls
The `BaseRun` class associated with this config.
#### serialize(reflective=False)
Serializes the object into a dictionary.
Serialization is applied recursively to all attributes in the object,
including element-wise serialization of lists and dictionary values.
* **Parameters:**
**reflective** – whether to include reflective attributes when
serializing the object. By default, this is False
* **Returns:**
a JSON dictionary representation of the object
#### to_str(pretty_print=True, \*\*kwargs)
Returns a string representation of this object.
* **Parameters:**
* **pretty_print** – whether to render the JSON in human readable format
with newlines and indentations. By default, this is True
* **\*\*kwargs** – optional keyword arguments for `self.serialize()`
* **Returns:**
a string representation of the object
#### *property* type
The type of run.
#### *static* validate_all_or_nothing_fields(fields)
Validates a dictionary of pre-parsed fields checking that either
all or none of the fields have a truthy value.
* **Parameters:**
**fields** – a dictionary of pre-parsed fields
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if some values are truth and some are not
#### write_json(path, pretty_print=False, \*\*kwargs)
Serializes the object and writes it to disk.
* **Parameters:**
* **path** – the output path
* **pretty_print** – whether to render the JSON in human readable format
with newlines and indentations. By default, this is False
* **\*\*kwargs** – optional keyword arguments for `self.serialize()`
### *class* fiftyone.utils.eval.base.BaseEvaluationMethod(config)
Bases: [`EvaluationMethod`](fiftyone.core.evaluation.md#fiftyone.core.evaluation.EvaluationMethod)
Base class for evaluation methods.
* **Parameters:**
**config** – an [`BaseEvaluationMethodConfig`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig)
**Methods:**
| [`compute_custom_metrics`](#fiftyone.utils.eval.base.BaseEvaluationMethod.compute_custom_metrics)(samples, eval_key, ...) | |
|--------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| [`get_custom_metric_fields`](#fiftyone.utils.eval.base.BaseEvaluationMethod.get_custom_metric_fields)(samples, eval_key) | |
| [`rename_custom_metrics`](#fiftyone.utils.eval.base.BaseEvaluationMethod.rename_custom_metrics)(samples, eval_key, ...) | |
| [`cleanup_custom_metrics`](#fiftyone.utils.eval.base.BaseEvaluationMethod.cleanup_custom_metrics)(samples, eval_key[, ...]) | |
| [`get_fields`](#fiftyone.utils.eval.base.BaseEvaluationMethod.get_fields)(samples, eval_key[, ...]) | Gets the fields that were involved in the given run. |
| [`add_fields_to_sidebar_group`](#fiftyone.utils.eval.base.BaseEvaluationMethod.add_fields_to_sidebar_group)(samples, eval_key) | |
| [`cleanup`](#fiftyone.utils.eval.base.BaseEvaluationMethod.cleanup)(samples, key) | Cleans up the results of the run with the given key from the collection. |
| [`delete_run`](#fiftyone.utils.eval.base.BaseEvaluationMethod.delete_run)(samples, key[, cleanup]) | Deletes the results associated with the given run key from the collection. |
| [`delete_runs`](#fiftyone.utils.eval.base.BaseEvaluationMethod.delete_runs)(samples[, cleanup]) | Deletes all runs from the collection. |
| [`ensure_requirements`](#fiftyone.utils.eval.base.BaseEvaluationMethod.ensure_requirements)() | Ensures that any necessary packages to execute this run are installed. |
| [`ensure_usage_requirements`](#fiftyone.utils.eval.base.BaseEvaluationMethod.ensure_usage_requirements)() | Ensures that any necessary packages to use existing results for this run are installed. |
| [`from_config`](#fiftyone.utils.eval.base.BaseEvaluationMethod.from_config)(config) | Instantiates a Configurable class from a Config instance. |
| [`from_dict`](#fiftyone.utils.eval.base.BaseEvaluationMethod.from_dict)(d) | Instantiates a Configurable class from a Config dict. |
| [`from_json`](#fiftyone.utils.eval.base.BaseEvaluationMethod.from_json)(json_path) | Instantiates a Configurable class from a Config JSON file. |
| [`from_kwargs`](#fiftyone.utils.eval.base.BaseEvaluationMethod.from_kwargs)(\*\*kwargs) | Instantiates a Configurable class from keyword arguments defining the attributes of a Config. |
| [`get_run_info`](#fiftyone.utils.eval.base.BaseEvaluationMethod.get_run_info)(samples, key) | Gets the `BaseRunInfo` for the given key on the collection. |
| [`has_cached_run_results`](#fiftyone.utils.eval.base.BaseEvaluationMethod.has_cached_run_results)(samples, key) | Determines whether `BaseRunResults` for the given key are cached on the collection. |
| [`list_runs`](#fiftyone.utils.eval.base.BaseEvaluationMethod.list_runs)(samples[, type, method]) | Returns the list of run keys on the given collection. |
| [`load_run_results`](#fiftyone.utils.eval.base.BaseEvaluationMethod.load_run_results)(samples, key[, cache, ...]) | Loads the `BaseRunResults` for the given key on the collection. |
| [`load_run_view`](#fiftyone.utils.eval.base.BaseEvaluationMethod.load_run_view)(samples, key[, select_fields]) | Loads the view on which the specified run was performed. |
| [`parse`](#fiftyone.utils.eval.base.BaseEvaluationMethod.parse)(class_name[, module_name]) | Parses a Configurable subclass name string. |
| [`register_run`](#fiftyone.utils.eval.base.BaseEvaluationMethod.register_run)(samples, key[, overwrite, cleanup]) | Registers a run of this method under the given key on the given collection. |
| [`rename`](#fiftyone.utils.eval.base.BaseEvaluationMethod.rename)(samples, key, new_key) | Performs any necessary operations required to rename this run's key. |
| [`run_info_cls`](#fiftyone.utils.eval.base.BaseEvaluationMethod.run_info_cls)() | The `BaseRunInfo` class associated with this class. |
| [`save_run_info`](#fiftyone.utils.eval.base.BaseEvaluationMethod.save_run_info)(samples, run_info[, ...]) | Saves the run information on the collection. |
| [`save_run_results`](#fiftyone.utils.eval.base.BaseEvaluationMethod.save_run_results)(samples, key, run_results) | Saves the run results on the collection. |
| [`update_run_config`](#fiftyone.utils.eval.base.BaseEvaluationMethod.update_run_config)(samples, key, config) | Updates the `BaseRunConfig` for the given run on the collection. |
| [`update_run_key`](#fiftyone.utils.eval.base.BaseEvaluationMethod.update_run_key)(samples, key, new_key) | Replaces the key for the given run with a new key. |
| [`validate`](#fiftyone.utils.eval.base.BaseEvaluationMethod.validate)(config) | Validates that the given config is an instance of Config. |
| [`validate_run`](#fiftyone.utils.eval.base.BaseEvaluationMethod.validate_run)(samples, key[, overwrite]) | Validates that the collection can accept this run. |
#### compute_custom_metrics(samples, eval_key, results, metric_uris=None)
#### get_custom_metric_fields(samples, eval_key, metric_uris=None)
#### rename_custom_metrics(samples, eval_key, new_eval_key, metric_uris=None)
#### cleanup_custom_metrics(samples, eval_key, metric_uris=None)
#### get_fields(samples, eval_key, include_custom_metrics=True)
Gets the fields that were involved in the given run.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **Returns:**
a list of fields
#### add_fields_to_sidebar_group(samples, eval_key, omit_fields=None)
#### cleanup(samples, key)
Cleans up the results of the run with the given key from the
collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
#### *classmethod* delete_run(samples, key, cleanup=True)
Deletes the results associated with the given run key from the
collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **cleanup** (*True*) – whether to execute the run’s
`BaseRun.cleanup()` method
#### *classmethod* delete_runs(samples, cleanup=True)
Deletes all runs from the collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **cleanup** (*True*) – whether to execute the run’s
`BaseRun.cleanup()` methods
#### ensure_requirements()
Ensures that any necessary packages to execute this run are
installed.
Runs should respect `fiftyone.config.requirement_error_level` when
handling errors.
#### ensure_usage_requirements()
Ensures that any necessary packages to use existing results for this
run are installed.
Runs should respect `fiftyone.config.requirement_error_level` when
handling errors.
#### *classmethod* from_config(config)
Instantiates a Configurable class from a Config instance.
#### *classmethod* from_dict(d)
Instantiates a Configurable class from a Config dict.
* **Parameters:**
**d** – a dict to construct a Config
* **Returns:**
an instance of cls
#### *classmethod* from_json(json_path)
Instantiates a Configurable class from a Config JSON file.
* **Parameters:**
**json_path** – path to a JSON file for type Config
* **Returns:**
an instance of cls
#### *classmethod* from_kwargs(\*\*kwargs)
Instantiates a Configurable class from keyword arguments defining
the attributes of a Config.
* **Parameters:**
**\*\*kwargs** – keyword arguments that define the fields of a
Config dict
* **Returns:**
an instance of cls
#### *classmethod* get_run_info(samples, key)
Gets the `BaseRunInfo` for the given key on the collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **Returns:**
a `BaseRunInfo`
#### *classmethod* has_cached_run_results(samples, key)
Determines whether `BaseRunResults` for the given key are
cached on the collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **Returns:**
True/False
#### *classmethod* list_runs(samples, type=None, method=None, \*\*kwargs)
Returns the list of run keys on the given collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **type** (*None*) –
a specific run type to match, which can be:
- a string [`fiftyone.core.runs.BaseRunConfig.type`](fiftyone.core.runs.md#fiftyone.core.runs.BaseRunConfig.type)
- a [`fiftyone.core.runs.BaseRun`](fiftyone.core.runs.md#fiftyone.core.runs.BaseRun) class or its
fully-qualified class name string
* **method** (*None*) – a specific
[`fiftyone.core.runs.BaseRunConfig.method`](fiftyone.core.runs.md#fiftyone.core.runs.BaseRunConfig.method) string to match
* **\*\*kwargs** – optional config parameters to match
* **Returns:**
a list of run keys
#### *classmethod* load_run_results(samples, key, cache=True, load_view=True, \*\*kwargs)
Loads the `BaseRunResults` for the given key on the
collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **cache** (*True*) – whether to cache the results on the collection
* **load_view** (*True*) – whether to load the run view in the results
(True) or the full dataset (False)
* **\*\*kwargs** – keyword arguments for the run’s
`BaseRunConfig.load_credentials()` method
* **Returns:**
a `BaseRunResults`, or None if the run did not save results
#### *classmethod* load_run_view(samples, key, select_fields=False)
Loads the view on which the specified run was performed.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **select_fields** (*False*) – whether to exclude fields involved in other
runs of the same type
* **Returns:**
a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
#### *static* parse(class_name, module_name=None)
Parses a Configurable subclass name string.
Assumes both the Configurable class and the Config class are defined
in the same module. The module containing the classes will be loaded
if necessary.
* **Parameters:**
* **class_name** – a string containing the name of the Configurable class,
e.g. “ClassName”, or a fully-qualified class name, e.g.
“eta.core.config.ClassName”
* **module_name** – a string containing the fully-qualified module name,
e.g. “eta.core.config”, or None if class_name includes the
module name. Set module_name = \_\_name_\_ to load a class from
the calling module
* **Returns:**
the Configurable class
config_cls: the Config class associated with cls
* **Return type:**
[cls](fiftyone.brain.internal.core.elasticsearch.md#fiftyone.brain.internal.core.elasticsearch.ElasticsearchSimilarityConfig.cls)
#### register_run(samples, key, overwrite=True, cleanup=True)
Registers a run of this method under the given key on the given
collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **overwrite** (*True*) – whether to allow overwriting an existing run of
the same type
* **cleanup** (*True*) – whether to execute an existing run’s
`BaseRun.cleanup()` method when overwriting it
#### rename(samples, key, new_key)
Performs any necessary operations required to rename this run’s key.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **new_key** – a new run key
#### *classmethod* run_info_cls()
The `BaseRunInfo` class associated with this class.
#### *classmethod* save_run_info(samples, run_info, overwrite=True, cleanup=True)
Saves the run information on the collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **run_info** – a `BaseRunInfo`
* **overwrite** (*True*) – whether to overwrite an existing run with the
same key
* **cleanup** (*True*) – whether to execute an existing run’s
`BaseRun.cleanup()` method when overwriting it
#### *classmethod* save_run_results(samples, key, run_results, overwrite=True, cache=True)
Saves the run results on the collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **run_results** – a `BaseRunResults`, or None
* **overwrite** (*True*) – whether to overwrite an existing result with the
same key
* **cache** (*True*) – whether to cache the results on the collection
#### *classmethod* update_run_config(samples, key, config)
Updates the `BaseRunConfig` for the given run on the
collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **config** – a `BaseRunConfig`
#### *classmethod* update_run_key(samples, key, new_key)
Replaces the key for the given run with a new key.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **new_key** – a new run key
#### *classmethod* validate(config)
Validates that the given config is an instance of Config.
* **Raises:**
**ConfigurableError** – if config is not an instance of Config
#### validate_run(samples, key, overwrite=True)
Validates that the collection can accept this run.
The run may be invalid if, for example, a run of a different type has
already been run under the same key and thus overwriting it would cause
ambiguity on how to cleanup the results.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **overwrite** (*True*) – whether to allow overwriting an existing run of
the same type
* **Raises:**
**ValueError** – if the run is invalid
### *class* fiftyone.utils.eval.base.BaseEvaluationResults(samples, config, eval_key, custom_metrics=None, backend=None)
Bases: [`EvaluationResults`](fiftyone.core.evaluation.md#fiftyone.core.evaluation.EvaluationResults)
Base class for evaluation results.
* **Parameters:**
* **samples** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) used
* **config** – the [`BaseEvaluationMethodConfig`](#fiftyone.utils.eval.base.BaseEvaluationMethodConfig) used
* **eval_key** – the evaluation key
* **custom_metrics** (*None*) – an optional dict of custom metrics
* **backend** (*None*) – an `EvaluationMethod` backend
**Methods:**
| [`add_custom_metrics`](#fiftyone.utils.eval.base.BaseEvaluationResults.add_custom_metrics)(custom_metrics[, overwrite]) | Computes the given custom metrics and adds them to these results. |
|---------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
| [`metrics`](#fiftyone.utils.eval.base.BaseEvaluationResults.metrics)(\*args, \*\*kwargs) | Returns the metrics associated with this evaluation run. |
| [`print_metrics`](#fiftyone.utils.eval.base.BaseEvaluationResults.print_metrics)(\*args[, digits]) | Prints the metrics computed via [`metrics()`](#fiftyone.utils.eval.base.BaseEvaluationResults.metrics). |
| [`attributes`](#fiftyone.utils.eval.base.BaseEvaluationResults.attributes)() | Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.utils.eval.base.BaseEvaluationResults.serialize). |
| [`base_results_cls`](#fiftyone.utils.eval.base.BaseEvaluationResults.base_results_cls)(type) | Returns the results class for the given run type. |
| [`copy`](#fiftyone.utils.eval.base.BaseEvaluationResults.copy)() | Returns a deep copy of the object. |
| [`custom_attributes`](#fiftyone.utils.eval.base.BaseEvaluationResults.custom_attributes)([dynamic, private]) | Returns a customizable list of class attributes. |
| [`from_dict`](#fiftyone.utils.eval.base.BaseEvaluationResults.from_dict)(d, samples, config, key) | Builds a `BaseRunResults` from a JSON dict representation of it. |
| [`from_json`](#fiftyone.utils.eval.base.BaseEvaluationResults.from_json)(path, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON file. |
| [`from_str`](#fiftyone.utils.eval.base.BaseEvaluationResults.from_str)(s, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON string. |
| [`get_class_name`](#fiftyone.utils.eval.base.BaseEvaluationResults.get_class_name)() | Returns the fully-qualified class name string of this object. |
| [`get_meta`](#fiftyone.utils.eval.base.BaseEvaluationResults.get_meta)() | Small facts that DESCRIBE these results, stored beside the run so callers can read them without loading the results. |
| [`save`](#fiftyone.utils.eval.base.BaseEvaluationResults.save)() | Saves the results to the database. |
| [`save_config`](#fiftyone.utils.eval.base.BaseEvaluationResults.save_config)() | Saves these results config to the database. |
| [`serialize`](#fiftyone.utils.eval.base.BaseEvaluationResults.serialize)([reflective]) | Serializes the object into a dictionary. |
| [`to_str`](#fiftyone.utils.eval.base.BaseEvaluationResults.to_str)([pretty_print]) | Returns a string representation of this object. |
| [`write_json`](#fiftyone.utils.eval.base.BaseEvaluationResults.write_json)(path[, pretty_print]) | Serializes the object and writes it to disk. |
**Attributes:**
| [`backend`](#fiftyone.utils.eval.base.BaseEvaluationResults.backend) | The `BaseRun` for these results. |
|------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`cls`](#fiftyone.utils.eval.base.BaseEvaluationResults.cls) | The fully-qualified name of this `BaseRunResults` class. |
| [`config`](#fiftyone.utils.eval.base.BaseEvaluationResults.config) | The `BaseRunConfig` for these results. |
| [`key`](#fiftyone.utils.eval.base.BaseEvaluationResults.key) | The run key for these results. |
| [`samples`](#fiftyone.utils.eval.base.BaseEvaluationResults.samples) | The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) associated with these results. |
#### add_custom_metrics(custom_metrics, overwrite=True)
Computes the given custom metrics and adds them to these results.
* **Parameters:**
* **custom_metrics** – a list of custom metrics to compute or a dict
mapping metric names to kwargs dicts
* **overwrite** (*True*) – whether to recompute any custom metrics that
have already been applied
#### metrics(\*args, \*\*kwargs)
Returns the metrics associated with this evaluation run.
Also includes any custom metrics from `custom_metrics`.
* **Parameters:**
* **\*args** – subclass-specific positional arguments
* **\*\*kwargs** – subclass-specific keyword arguments
* **Returns:**
a dict
#### print_metrics(\*args, digits=2, \*\*kwargs)
Prints the metrics computed via [`metrics()`](#fiftyone.utils.eval.base.BaseEvaluationResults.metrics).
* **Parameters:**
* **\*args** – subclass-specific positional arguments
* **digits** (*2*) – the number of digits of precision to print
* **\*\*kwargs** – subclass-specific keyword argument
#### attributes()
Returns the list of class attributes that will be serialized by
[`serialize()`](#fiftyone.utils.eval.base.BaseEvaluationResults.serialize).
* **Returns:**
a list of attributes
#### *property* backend
The `BaseRun` for these results.
#### *static* base_results_cls(type)
Returns the results class for the given run type.
* **Parameters:**
**type** – a `BaseRunConfig.type`
* **Returns:**
a `BaseRunResults` subclass
#### *property* cls
The fully-qualified name of this `BaseRunResults` class.
#### *property* config
The `BaseRunConfig` for these results.
#### copy()
Returns a deep copy of the object.
* **Returns:**
a Serializable instance
#### custom_attributes(dynamic=False, private=False)
Returns a customizable list of class attributes.
By default, all attributes in vars(self) are returned, minus private
attributes (those starting with “_”).
* **Parameters:**
* **dynamic** – whether to include dynamic properties, e.g., those defined
by getter/setter methods or the `@property` decorator. By
default, this is False
* **private** – whether to include private properties, i.e., those
starting with “_”. By default, this is False
* **Returns:**
a list of class attributes
#### *classmethod* from_dict(d, samples, config, key)
Builds a `BaseRunResults` from a JSON dict representation of
it.
* **Parameters:**
* **d** – a JSON dict
* **samples** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
for the run
* **config** – the `BaseRunConfig` for the run
* **key** – the run key
* **Returns:**
a `BaseRunResults`
#### *classmethod* from_json(path, \*args, \*\*kwargs)
Constructs a Serializable object from a JSON file.
Subclasses may override this method, but, by default, this method
simply reads the JSON and calls from_dict(), which subclasses must
implement.
* **Parameters:**
* **path** – the path to the JSON file on disk
* **\*args** – optional positional arguments for `self.from_dict()`
* **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
an instance of the Serializable class
#### *classmethod* from_str(s, \*args, \*\*kwargs)
Constructs a Serializable object from a JSON string.
Subclasses may override this method, but, by default, this method
simply parses the string and calls from_dict(), which subclasses must
implement.
* **Parameters:**
* **s** – a JSON string representation of a Serializable object
* **\*args** – optional positional arguments for `self.from_dict()`
* **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
an instance of the Serializable class
#### *classmethod* get_class_name()
Returns the fully-qualified class name string of this object.
#### get_meta()
Small facts that DESCRIBE these results, stored beside the run so
callers can read them without loading the results.
The results themselves are a blob in GridFS whose arrays can run to
hundreds of MB; a count or a path is a few bytes. Anything returned
here is written when the results are saved (see
`BaseRun.save_run_results()`), so no read path has to load — or
write — to answer for it.
* **Returns:**
a JSON-serializable dict
#### *property* key
The run key for these results.
#### *property* samples
The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) associated
with these results.
#### save()
Saves the results to the database.
#### save_config()
Saves these results config to the database.
#### serialize(reflective=False)
Serializes the object into a dictionary.
Serialization is applied recursively to all attributes in the object,
including element-wise serialization of lists and dictionary values.
* **Parameters:**
**reflective** – whether to include reflective attributes when
serializing the object. By default, this is False
* **Returns:**
a JSON dictionary representation of the object
#### to_str(pretty_print=True, \*\*kwargs)
Returns a string representation of this object.
* **Parameters:**
* **pretty_print** – whether to render the JSON in human readable format
with newlines and indentations. By default, this is True
* **\*\*kwargs** – optional keyword arguments for `self.serialize()`
* **Returns:**
a string representation of the object
#### write_json(path, pretty_print=False, \*\*kwargs)
Serializes the object and writes it to disk.
* **Parameters:**
* **path** – the output path
* **pretty_print** – whether to render the JSON in human readable format
with newlines and indentations. By default, this is False
* **\*\*kwargs** – optional keyword arguments for `self.serialize()`
### *class* fiftyone.utils.eval.base.BaseClassificationResults(samples, config, eval_key, ytrue, ypred, confs=None, weights=None, ytrue_ids=None, ypred_ids=None, classes=None, missing=None, custom_metrics=None, backend=None)
Bases: [`BaseEvaluationResults`](#fiftyone.utils.eval.base.BaseEvaluationResults)
Base class for evaluation results that expose classification metrics
like P/R/F1 and confusion matrices.
* **Parameters:**
* **samples** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) used
* **config** – the [`fiftyone.core.evaluation.EvaluationMethodConfig`](fiftyone.core.evaluation.md#fiftyone.core.evaluation.EvaluationMethodConfig)
used
* **eval_key** – the evaluation key
* **ytrue** – a list of ground truth labels
* **ypred** – a list of predicted labels
* **confs** (*None*) – an optional list of confidences for the predictions
* **weights** (*None*) – an optional list of sample weights
* **ytrue_ids** (*None*) – a list of IDs for the ground truth labels
* **ypred_ids** (*None*) – a list of IDs for the predicted labels
* **classes** (*None*) – the list of possible classes. If not provided, the
observed ground truth/predicted labels are used
* **missing** (*None*) – a missing label string. Any None-valued labels are
given this label for evaluation purposes
* **custom_metrics** (*None*) – an optional dict of custom metrics
* **backend** (*None*) – a [`fiftyone.core.evaluation.EvaluationMethod`](fiftyone.core.evaluation.md#fiftyone.core.evaluation.EvaluationMethod)
backend
**Attributes:**
| [`has_subset`](#fiftyone.utils.eval.base.BaseClassificationResults.has_subset) | Whether these results are currently restricted to a subset via [`use_subset()`](#fiftyone.utils.eval.base.BaseClassificationResults.use_subset). |
|----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`backend`](#fiftyone.utils.eval.base.BaseClassificationResults.backend) | The `BaseRun` for these results. |
| [`cls`](#fiftyone.utils.eval.base.BaseClassificationResults.cls) | The fully-qualified name of this `BaseRunResults` class. |
| [`config`](#fiftyone.utils.eval.base.BaseClassificationResults.config) | The `BaseRunConfig` for these results. |
| [`key`](#fiftyone.utils.eval.base.BaseClassificationResults.key) | The run key for these results. |
| [`samples`](#fiftyone.utils.eval.base.BaseClassificationResults.samples) | The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) associated with these results. |
**Methods:**
| [`use_subset`](#fiftyone.utils.eval.base.BaseClassificationResults.use_subset)(subset_def) | Restricts the evaluation results to the specified subset. |
|-----------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`clear_subset`](#fiftyone.utils.eval.base.BaseClassificationResults.clear_subset)() | Clears the subset set by [`use_subset()`](#fiftyone.utils.eval.base.BaseClassificationResults.use_subset), if any. |
| [`report`](#fiftyone.utils.eval.base.BaseClassificationResults.report)([classes]) | Generates a classification report for the results via [`sklearn.metrics.classification_report()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.classification_report.html#sklearn.metrics.classification_report). |
| [`print_report`](#fiftyone.utils.eval.base.BaseClassificationResults.print_report)([classes, digits]) | Prints a classification report for the results via [`sklearn.metrics.classification_report()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.classification_report.html#sklearn.metrics.classification_report). |
| [`metrics`](#fiftyone.utils.eval.base.BaseClassificationResults.metrics)([classes, average, beta]) | Computes classification metrics for the results, including accuracy, precision, recall, and F-beta score. |
| [`print_metrics`](#fiftyone.utils.eval.base.BaseClassificationResults.print_metrics)([classes, average, beta, digits]) | Prints the metrics computed via [`metrics()`](#fiftyone.utils.eval.base.BaseClassificationResults.metrics). |
| [`confusion_matrix`](#fiftyone.utils.eval.base.BaseClassificationResults.confusion_matrix)([classes, include_other, ...]) | Generates a confusion matrix for the results via [`sklearn.metrics.confusion_matrix()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html#sklearn.metrics.confusion_matrix). |
| [`plot_confusion_matrix`](#fiftyone.utils.eval.base.BaseClassificationResults.plot_confusion_matrix)([classes, ...]) | Plots a confusion matrix for the evaluation results. |
| [`add_custom_metrics`](#fiftyone.utils.eval.base.BaseClassificationResults.add_custom_metrics)(custom_metrics[, overwrite]) | Computes the given custom metrics and adds them to these results. |
| [`attributes`](#fiftyone.utils.eval.base.BaseClassificationResults.attributes)() | Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.utils.eval.base.BaseClassificationResults.serialize). |
| [`base_results_cls`](#fiftyone.utils.eval.base.BaseClassificationResults.base_results_cls)(type) | Returns the results class for the given run type. |
| [`copy`](#fiftyone.utils.eval.base.BaseClassificationResults.copy)() | Returns a deep copy of the object. |
| [`custom_attributes`](#fiftyone.utils.eval.base.BaseClassificationResults.custom_attributes)([dynamic, private]) | Returns a customizable list of class attributes. |
| [`from_dict`](#fiftyone.utils.eval.base.BaseClassificationResults.from_dict)(d, samples, config, key) | Builds a `BaseRunResults` from a JSON dict representation of it. |
| [`from_json`](#fiftyone.utils.eval.base.BaseClassificationResults.from_json)(path, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON file. |
| [`from_str`](#fiftyone.utils.eval.base.BaseClassificationResults.from_str)(s, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON string. |
| [`get_class_name`](#fiftyone.utils.eval.base.BaseClassificationResults.get_class_name)() | Returns the fully-qualified class name string of this object. |
| [`get_meta`](#fiftyone.utils.eval.base.BaseClassificationResults.get_meta)() | Small facts that DESCRIBE these results, stored beside the run so callers can read them without loading the results. |
| [`save`](#fiftyone.utils.eval.base.BaseClassificationResults.save)() | Saves the results to the database. |
| [`save_config`](#fiftyone.utils.eval.base.BaseClassificationResults.save_config)() | Saves these results config to the database. |
| [`serialize`](#fiftyone.utils.eval.base.BaseClassificationResults.serialize)([reflective]) | Serializes the object into a dictionary. |
| [`to_str`](#fiftyone.utils.eval.base.BaseClassificationResults.to_str)([pretty_print]) | Returns a string representation of this object. |
| [`write_json`](#fiftyone.utils.eval.base.BaseClassificationResults.write_json)(path[, pretty_print]) | Serializes the object and writes it to disk. |
#### *property* has_subset
Whether these results are currently restricted to a subset via
[`use_subset()`](#fiftyone.utils.eval.base.BaseClassificationResults.use_subset).
#### use_subset(subset_def)
Restricts the evaluation results to the specified subset.
Subsequent calls to supported methods on this instance will only
contain results from the specified subset rather than the full results.
Use [`clear_subset()`](#fiftyone.utils.eval.base.BaseClassificationResults.clear_subset) to reset to the full results. Or,
equivalently, use the context manager interface as demonstrated below
to automatically reset the results when the context exits.
Example usage:
```default
import fiftyone as fo
import fiftyone.zoo as foz
import fiftyone.utils.random as four
from fiftyone import ViewField as F
dataset = foz.load_zoo_dataset("quickstart")
four.random_split(dataset, {"sunny": 0.7, "cloudy": 0.2, "rainy": 0.1})
results = dataset.evaluate_detections(
"predictions",
gt_field="ground_truth",
eval_key="eval",
)
counts = dataset.count_values("ground_truth.detections.label")
classes = sorted(counts, key=counts.get, reverse=True)[:5]
# Full results
results.print_report(classes=classes)
# Sunny samples
subset_def = dict(type="field", field="tags", value="sunny")
with results.use_subset(subset_def):
results.print_report(classes=classes)
# Small objects
bbox_area = F("bounding_box")[2] * F("bounding_box")[3]
small_objects = bbox_area <= 0.05
subset_def = dict(type="attribute", expr=small_objects)
with results.use_subset(subset_def):
results.print_report(classes=classes)
```
* **Parameters:**
**subset_def** –
the subset definition, which can be:
- a dict or list of dicts defining the subset. See above
for examples and see [`get_subset_view()`](#fiftyone.utils.eval.base.get_subset_view) for full
syntax
- a [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView) defining the
subset
* **Returns:**
self
#### clear_subset()
Clears the subset set by [`use_subset()`](#fiftyone.utils.eval.base.BaseClassificationResults.use_subset), if any.
Subsequent operations will be performed on the full results.
#### report(classes=None)
Generates a classification report for the results via
[`sklearn.metrics.classification_report()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.classification_report.html#sklearn.metrics.classification_report).
* **Parameters:**
**classes** (*None*) – an optional list of classes to include in the
report
* **Returns:**
a dict
#### print_report(classes=None, digits=2)
Prints a classification report for the results via
[`sklearn.metrics.classification_report()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.classification_report.html#sklearn.metrics.classification_report).
* **Parameters:**
* **classes** (*None*) – an optional list of classes to include in the
report
* **digits** (*2*) – the number of digits of precision to print
#### metrics(classes=None, average='micro', beta=1.0)
Computes classification metrics for the results, including accuracy,
precision, recall, and F-beta score.
See [`sklearn.metrics.precision_recall_fscore_support()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.precision_recall_fscore_support.html#sklearn.metrics.precision_recall_fscore_support) for
details.
Also includes any custom metrics from `custom_metrics`.
* **Parameters:**
* **classes** (*None*) – an optional list of classes to include in the
calculations
* **average** ( *"micro"*) – the averaging strategy to use
* **beta** (*1.0*) – the F-beta value to use
* **Returns:**
a dict
#### print_metrics(classes=None, average='micro', beta=1.0, digits=2)
Prints the metrics computed via [`metrics()`](#fiftyone.utils.eval.base.BaseClassificationResults.metrics).
* **Parameters:**
* **classes** (*None*) – an optional list of classes to include in the
calculations
* **average** ( *"micro"*) – the averaging strategy to use
* **beta** (*1.0*) – the F-beta value to use
* **digits** (*2*) – the number of digits of precision to print
#### confusion_matrix(classes=None, include_other=False, include_missing=False)
Generates a confusion matrix for the results via
[`sklearn.metrics.confusion_matrix()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html#sklearn.metrics.confusion_matrix).
The rows of the confusion matrix represent ground truth and the columns
represent predictions.
* **Parameters:**
* **classes** (*None*) – an optional list of classes to include in the
confusion matrix
* **include_other** (*False*) – whether to include an extra row/column at
the end of the matrix for labels that do not appear in
`classes`. Only applicable if `classes` are provided
* **include_missing** (*False*) – whether to include a row/column at the end
of the matrix for unmatched labels. Only applicable if
`self.missing` does not already appear in `classes`. If
both “other” and “missing” rows/columns are requested, this one
is last
* **Returns:**
a `num_classes x num_classes` confusion matrix
#### plot_confusion_matrix(classes=None, include_other=None, include_missing=None, other_label='(other)', backend='plotly', \*\*kwargs)
Plots a confusion matrix for the evaluation results.
If you are working in a notebook environment with the default plotly
backend, this method returns an interactive
[`fiftyone.core.plots.plotly.InteractiveHeatmap`](fiftyone.core.plots.plotly.md#fiftyone.core.plots.plotly.InteractiveHeatmap) that you can
attach to an App session via its
[`fiftyone.core.session.Session.plots`](fiftyone.core.session.md#fiftyone.core.session.Session.plots) attribute, which will
automatically sync the session’s view with the currently selected cells
in the confusion matrix.
* **Parameters:**
* **classes** (*None*) – an optional list of classes to include in the
confusion matrix
* **include_other** (*None*) –
whether to include a row/column for examples
whose label is in `classes` but are matched to labels that
do not appear in `classes`. Only applicable if `classes`
are provided. The supported values are:
- None (default): only include a row/column for other labels
if there are any
- True: do include a row/column for other labels
- False: do not include a row/column for other labels
* **include_missing** (*None*) –
whether to include a row/column for missing
ground truth/predictions in the confusion matrix. The supported
values are:
- None (default): only include a row/column for missing
labels if there are any
- True: do include a row/column for missing labels
- False: do not include a row/column for missing labels
* **other_label** ( *"* *(**other* *)* *"*) – the label to use for “other” predictions
* **backend** ( *"plotly"*) – the plotting backend to use. Supported values
are `("plotly", "matplotlib")`
* **\*\*kwargs** –
keyword arguments for the backend plotting method:
- ”plotly” backend: [`fiftyone.core.plots.plotly.plot_confusion_matrix()`](fiftyone.core.plots.plotly.md#fiftyone.core.plots.plotly.plot_confusion_matrix)
- ”matplotlib” backend: [`fiftyone.core.plots.matplotlib.plot_confusion_matrix()`](fiftyone.core.plots.matplotlib.md#fiftyone.core.plots.matplotlib.plot_confusion_matrix)
* **Returns:**
- a [`fiftyone.core.plots.plotly.InteractiveHeatmap`](fiftyone.core.plots.plotly.md#fiftyone.core.plots.plotly.InteractiveHeatmap), if
the plotly backend is used
- a matplotlib figure, otherwise
* **Return type:**
one of the following
#### add_custom_metrics(custom_metrics, overwrite=True)
Computes the given custom metrics and adds them to these results.
* **Parameters:**
* **custom_metrics** – a list of custom metrics to compute or a dict
mapping metric names to kwargs dicts
* **overwrite** (*True*) – whether to recompute any custom metrics that
have already been applied
#### attributes()
Returns the list of class attributes that will be serialized by
[`serialize()`](#fiftyone.utils.eval.base.BaseClassificationResults.serialize).
* **Returns:**
a list of attributes
#### *property* backend
The `BaseRun` for these results.
#### *static* base_results_cls(type)
Returns the results class for the given run type.
* **Parameters:**
**type** – a `BaseRunConfig.type`
* **Returns:**
a `BaseRunResults` subclass
#### *property* cls
The fully-qualified name of this `BaseRunResults` class.
#### *property* config
The `BaseRunConfig` for these results.
#### copy()
Returns a deep copy of the object.
* **Returns:**
a Serializable instance
#### custom_attributes(dynamic=False, private=False)
Returns a customizable list of class attributes.
By default, all attributes in vars(self) are returned, minus private
attributes (those starting with “_”).
* **Parameters:**
* **dynamic** – whether to include dynamic properties, e.g., those defined
by getter/setter methods or the `@property` decorator. By
default, this is False
* **private** – whether to include private properties, i.e., those
starting with “_”. By default, this is False
* **Returns:**
a list of class attributes
#### *classmethod* from_dict(d, samples, config, key)
Builds a `BaseRunResults` from a JSON dict representation of
it.
* **Parameters:**
* **d** – a JSON dict
* **samples** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
for the run
* **config** – the `BaseRunConfig` for the run
* **key** – the run key
* **Returns:**
a `BaseRunResults`
#### *classmethod* from_json(path, \*args, \*\*kwargs)
Constructs a Serializable object from a JSON file.
Subclasses may override this method, but, by default, this method
simply reads the JSON and calls from_dict(), which subclasses must
implement.
* **Parameters:**
* **path** – the path to the JSON file on disk
* **\*args** – optional positional arguments for `self.from_dict()`
* **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
an instance of the Serializable class
#### *classmethod* from_str(s, \*args, \*\*kwargs)
Constructs a Serializable object from a JSON string.
Subclasses may override this method, but, by default, this method
simply parses the string and calls from_dict(), which subclasses must
implement.
* **Parameters:**
* **s** – a JSON string representation of a Serializable object
* **\*args** – optional positional arguments for `self.from_dict()`
* **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
an instance of the Serializable class
#### *classmethod* get_class_name()
Returns the fully-qualified class name string of this object.
#### get_meta()
Small facts that DESCRIBE these results, stored beside the run so
callers can read them without loading the results.
The results themselves are a blob in GridFS whose arrays can run to
hundreds of MB; a count or a path is a few bytes. Anything returned
here is written when the results are saved (see
`BaseRun.save_run_results()`), so no read path has to load — or
write — to answer for it.
* **Returns:**
a JSON-serializable dict
#### *property* key
The run key for these results.
#### *property* samples
The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) associated
with these results.
#### save()
Saves the results to the database.
#### save_config()
Saves these results config to the database.
#### serialize(reflective=False)
Serializes the object into a dictionary.
Serialization is applied recursively to all attributes in the object,
including element-wise serialization of lists and dictionary values.
* **Parameters:**
**reflective** – whether to include reflective attributes when
serializing the object. By default, this is False
* **Returns:**
a JSON dictionary representation of the object
#### to_str(pretty_print=True, \*\*kwargs)
Returns a string representation of this object.
* **Parameters:**
* **pretty_print** – whether to render the JSON in human readable format
with newlines and indentations. By default, this is True
* **\*\*kwargs** – optional keyword arguments for `self.serialize()`
* **Returns:**
a string representation of the object
#### write_json(path, pretty_print=False, \*\*kwargs)
Serializes the object and writes it to disk.
* **Parameters:**
* **path** – the output path
* **pretty_print** – whether to render the JSON in human readable format
with newlines and indentations. By default, this is False
* **\*\*kwargs** – optional keyword arguments for `self.serialize()`