# fiftyone.utils.eval.regression Regression evaluation. Copyright 2017-2026, Voxel51, Inc.
[voxel51.com](https://voxel51.com/)

**Functions:** | [`evaluate_regressions`](#fiftyone.utils.eval.regression.evaluate_regressions)(samples, pred_field[, ...]) | Evaluates the regression predictions in the given collection with respect to the specified ground truth values. | |--------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| **Classes:** | [`RegressionEvaluationConfig`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig)(pred_field, gt_field) | Base class for configuring [`RegressionEvaluation`](#fiftyone.utils.eval.regression.RegressionEvaluation) instances. | |--------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| | [`RegressionEvaluation`](#fiftyone.utils.eval.regression.RegressionEvaluation)(config) | Base class for regression evaluation methods. | | [`SimpleEvaluationConfig`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig)(pred_field, gt_field) | Base class for configuring [`SimpleEvaluation`](#fiftyone.utils.eval.regression.SimpleEvaluation) instances. | | [`SimpleEvaluation`](#fiftyone.utils.eval.regression.SimpleEvaluation)(config) | Simple regression evaluation. | | [`RegressionResults`](#fiftyone.utils.eval.regression.RegressionResults)(samples, config, eval_key, ...) | Class that stores the results of a regression evaluation. | ### fiftyone.utils.eval.regression.evaluate_regressions(samples, pred_field, gt_field='ground_truth', eval_key=None, missing=None, method=None, custom_metrics=None, progress=None, \*\*kwargs) Evaluates the regression predictions in the given collection with respect to the specified ground truth values. You can customize the evaluation method by passing additional parameters for the method’s config class as `kwargs`. The natively provided `method` values and their associated configs are: - `"simple"`: [`SimpleEvaluationConfig`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig) If an `eval_key` is specified, then this method will record some statistics on each sample: - When evaluating sample-level fields, an `eval_key` field will be populated on each sample recording the error of that sample’s prediction. - When evaluating frame-level fields, an `eval_key` field will be populated on each frame recording the error of that frame’s prediction. In addition, an `eval_key` field will be populated on each sample that records the average error of the frame predictions of the sample. * **Parameters:** * **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) * **pred_field** – the name of the field containing the predicted [`fiftyone.core.labels.Regression`](fiftyone.core.labels.md#fiftyone.core.labels.Regression) instances * **gt_field** ( *"ground_truth"*) – the name of the field containing the ground truth [`fiftyone.core.labels.Regression`](fiftyone.core.labels.md#fiftyone.core.labels.Regression) instances * **eval_key** (*None*) – a string key to use to refer to this evaluation * **missing** (*None*) – a missing value. Any None-valued regressions are given this value for results purposes * **method** (*None*) – a string specifying the evaluation method to use. The supported values are `fo.evaluation_config.regression_backends.keys()` and the default is `fo.evaluation_config.default_regression_backend` * **custom_metrics** (*None*) – an optional list of custom metrics to compute or dict mapping metric names to kwargs dicts * **progress** (*None*) – whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead * **\*\*kwargs** – optional keyword arguments for the constructor of the [`RegressionEvaluationConfig`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig) being used * **Returns:** a [`RegressionResults`](#fiftyone.utils.eval.regression.RegressionResults) ### *class* fiftyone.utils.eval.regression.RegressionEvaluationConfig(pred_field, gt_field, custom_metrics=None, \*\*kwargs) Bases: [`BaseEvaluationMethodConfig`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig) Base class for configuring [`RegressionEvaluation`](#fiftyone.utils.eval.regression.RegressionEvaluation) instances. * **Parameters:** * **pred_field** – the name of the field containing the predicted [`fiftyone.core.labels.Regression`](fiftyone.core.labels.md#fiftyone.core.labels.Regression) instances * **gt_field** ( *"ground_truth"*) – the name of the field containing the ground truth [`fiftyone.core.labels.Regression`](fiftyone.core.labels.md#fiftyone.core.labels.Regression) instances * **custom_metrics** (*None*) – an optional list of custom metrics to compute or dict mapping metric names to kwargs dicts **Attributes:** | [`type`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.type) | The type of run. | |---------------------------------------------------------------------------------|---------------------------------------------------------| | [`cls`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.cls) | The fully-qualified name of this `BaseRunConfig` class. | | [`method`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.method) | The name of the method. | | [`run_cls`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.run_cls) | The `BaseRun` class associated with this config. | **Methods:** | [`attributes`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.attributes)() | Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.serialize). | |-----------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| | [`base_config_cls`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.base_config_cls)(type) | Returns the config class for the given run type. | | [`build`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.build)() | Builds the `BaseRun` instance associated with this config. | | [`builder`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.builder)() | Returns a ConfigBuilder instance for this class. | | [`copy`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.copy)() | Returns a deep copy of the object. | | [`custom_attributes`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.custom_attributes)([dynamic, private]) | Returns a customizable list of class attributes. | | [`default`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.default)() | Returns the default config instance. | | [`from_dict`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.from_dict)(d) | Constructs a `BaseRunConfig` from a serialized JSON dict representation of it. | | [`from_json`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.from_json)(path, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON file. | | [`from_kwargs`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.from_kwargs)(\*\*kwargs) | Constructs a Config object from keyword arguments. | | [`from_str`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.from_str)(s, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON string. | | [`get_class_name`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.get_class_name)() | Returns the fully-qualified class name string of this object. | | [`load_credentials`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.load_credentials)(\*\*kwargs) | Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config. | | [`load_default`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.load_default)() | Loads the default config instance from file. | | [`parse_array`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_array)(d, key[, default]) | Parses a raw array attribute. | | [`parse_bool`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_bool)(d, key[, default]) | Parses a boolean value. | | [`parse_categorical`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.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.regression.RegressionEvaluationConfig.parse_dict)(d, key[, default]) | Parses a dictionary attribute. | | [`parse_int`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_int)(d, key[, default]) | Parses an integer attribute. | | [`parse_mutually_exclusive_fields`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.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.regression.RegressionEvaluationConfig.parse_number)(d, key[, default]) | Parses a number attribute. | | [`parse_object`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_object)(d, key, cls[, default]) | Parses an object attribute. | | [`parse_object_array`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_object_array)(d, key, cls[, default]) | Parses an array of objects. | | [`parse_object_dict`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_object_dict)(d, key, cls[, default]) | Parses a dictionary whose values are objects. | | [`parse_path`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_path)(d, key[, default]) | Parses a path attribute. | | [`parse_raw`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_raw)(d, key[, default]) | Parses a raw (arbitrary) JSON field. | | [`parse_string`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_string)(d, key[, default]) | Parses a string attribute. | | [`serialize`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.serialize)([reflective]) | Serializes the object into a dictionary. | | [`to_str`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.to_str)([pretty_print]) | Returns a string representation of this object. | | [`validate_all_or_nothing_fields`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.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.regression.RegressionEvaluationConfig.write_json)(path[, pretty_print]) | Serializes the object and writes it to disk. | #### *property* type The type of run. #### attributes() Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig.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 #### *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.regression.RegressionEvaluation(config) Bases: [`BaseEvaluationMethod`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod) Base class for regression evaluation methods. * **Parameters:** **config** – a [`RegressionEvaluationConfig`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig) **Methods:** | [`register_samples`](#fiftyone.utils.eval.regression.RegressionEvaluation.register_samples)(samples, eval_key) | Registers the collection on which evaluation will be performed. | |--------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| | [`evaluate_samples`](#fiftyone.utils.eval.regression.RegressionEvaluation.evaluate_samples)(samples[, eval_key, ...]) | Evaluates the regression predictions in the given samples with respect to the specified ground truth values. | | [`get_fields`](#fiftyone.utils.eval.regression.RegressionEvaluation.get_fields)(samples, eval_key[, ...]) | Gets the fields that were involved in the given run. | | [`rename`](#fiftyone.utils.eval.regression.RegressionEvaluation.rename)(samples, eval_key, new_eval_key) | Performs any necessary operations required to rename this run's key. | | [`cleanup`](#fiftyone.utils.eval.regression.RegressionEvaluation.cleanup)(samples, eval_key) | Cleans up the results of the run with the given key from the collection. | | [`add_fields_to_sidebar_group`](#fiftyone.utils.eval.regression.RegressionEvaluation.add_fields_to_sidebar_group)(samples, eval_key) | | | [`cleanup_custom_metrics`](#fiftyone.utils.eval.regression.RegressionEvaluation.cleanup_custom_metrics)(samples, eval_key[, ...]) | | | [`compute_custom_metrics`](#fiftyone.utils.eval.regression.RegressionEvaluation.compute_custom_metrics)(samples, eval_key, ...) | | | [`delete_run`](#fiftyone.utils.eval.regression.RegressionEvaluation.delete_run)(samples, key[, cleanup]) | Deletes the results associated with the given run key from the collection. | | [`delete_runs`](#fiftyone.utils.eval.regression.RegressionEvaluation.delete_runs)(samples[, cleanup]) | Deletes all runs from the collection. | | [`ensure_requirements`](#fiftyone.utils.eval.regression.RegressionEvaluation.ensure_requirements)() | Ensures that any necessary packages to execute this run are installed. | | [`ensure_usage_requirements`](#fiftyone.utils.eval.regression.RegressionEvaluation.ensure_usage_requirements)() | Ensures that any necessary packages to use existing results for this run are installed. | | [`from_config`](#fiftyone.utils.eval.regression.RegressionEvaluation.from_config)(config) | Instantiates a Configurable class from a Config instance. | | [`from_dict`](#fiftyone.utils.eval.regression.RegressionEvaluation.from_dict)(d) | Instantiates a Configurable class from a Config dict. | | [`from_json`](#fiftyone.utils.eval.regression.RegressionEvaluation.from_json)(json_path) | Instantiates a Configurable class from a Config JSON file. | | [`from_kwargs`](#fiftyone.utils.eval.regression.RegressionEvaluation.from_kwargs)(\*\*kwargs) | Instantiates a Configurable class from keyword arguments defining the attributes of a Config. | | [`get_custom_metric_fields`](#fiftyone.utils.eval.regression.RegressionEvaluation.get_custom_metric_fields)(samples, eval_key) | | | [`get_run_info`](#fiftyone.utils.eval.regression.RegressionEvaluation.get_run_info)(samples, key) | Gets the `BaseRunInfo` for the given key on the collection. | | [`has_cached_run_results`](#fiftyone.utils.eval.regression.RegressionEvaluation.has_cached_run_results)(samples, key) | Determines whether `BaseRunResults` for the given key are cached on the collection. | | [`list_runs`](#fiftyone.utils.eval.regression.RegressionEvaluation.list_runs)(samples[, type, method]) | Returns the list of run keys on the given collection. | | [`load_run_results`](#fiftyone.utils.eval.regression.RegressionEvaluation.load_run_results)(samples, key[, cache, ...]) | Loads the `BaseRunResults` for the given key on the collection. | | [`load_run_view`](#fiftyone.utils.eval.regression.RegressionEvaluation.load_run_view)(samples, key[, select_fields]) | Loads the view on which the specified run was performed. | | [`parse`](#fiftyone.utils.eval.regression.RegressionEvaluation.parse)(class_name[, module_name]) | Parses a Configurable subclass name string. | | [`register_run`](#fiftyone.utils.eval.regression.RegressionEvaluation.register_run)(samples, key[, overwrite, cleanup]) | Registers a run of this method under the given key on the given collection. | | [`rename_custom_metrics`](#fiftyone.utils.eval.regression.RegressionEvaluation.rename_custom_metrics)(samples, eval_key, ...) | | | [`run_info_cls`](#fiftyone.utils.eval.regression.RegressionEvaluation.run_info_cls)() | The `BaseRunInfo` class associated with this class. | | [`save_run_info`](#fiftyone.utils.eval.regression.RegressionEvaluation.save_run_info)(samples, run_info[, ...]) | Saves the run information on the collection. | | [`save_run_results`](#fiftyone.utils.eval.regression.RegressionEvaluation.save_run_results)(samples, key, run_results) | Saves the run results on the collection. | | [`update_run_config`](#fiftyone.utils.eval.regression.RegressionEvaluation.update_run_config)(samples, key, config) | Updates the `BaseRunConfig` for the given run on the collection. | | [`update_run_key`](#fiftyone.utils.eval.regression.RegressionEvaluation.update_run_key)(samples, key, new_key) | Replaces the key for the given run with a new key. | | [`validate`](#fiftyone.utils.eval.regression.RegressionEvaluation.validate)(config) | Validates that the given config is an instance of Config. | | [`validate_run`](#fiftyone.utils.eval.regression.RegressionEvaluation.validate_run)(samples, key[, overwrite]) | Validates that the collection can accept this run. | #### register_samples(samples, eval_key) Registers the collection on which evaluation will be performed. This method will be called before calling [`evaluate_samples()`](#fiftyone.utils.eval.regression.RegressionEvaluation.evaluate_samples). Subclasses can extend this method to perform any setup required for an evaluation run. * **Parameters:** * **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) * **eval_key** – the evaluation key for this evaluation #### evaluate_samples(samples, eval_key=None, missing=None, progress=None) Evaluates the regression predictions in the given samples with respect to the specified ground truth values. * **Parameters:** * **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) * **eval_key** (*None*) – an evaluation key for this evaluation * **missing** (*None*) – a missing value. Any None-valued regressions are given this value for results purposes * **progress** (*None*) – whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead * **Returns:** a [`RegressionResults`](#fiftyone.utils.eval.regression.RegressionResults) instance #### 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 #### rename(samples, eval_key, new_eval_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 #### cleanup(samples, eval_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 #### add_fields_to_sidebar_group(samples, eval_key, omit_fields=None) #### cleanup_custom_metrics(samples, eval_key, metric_uris=None) #### compute_custom_metrics(samples, eval_key, results, metric_uris=None) #### *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 #### get_custom_metric_fields(samples, eval_key, metric_uris=None) #### *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_custom_metrics(samples, eval_key, new_eval_key, metric_uris=None) #### *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.regression.SimpleEvaluationConfig(pred_field, gt_field, metric='squared_error', custom_metrics=None, \*\*kwargs) Bases: [`RegressionEvaluationConfig`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig) Base class for configuring [`SimpleEvaluation`](#fiftyone.utils.eval.regression.SimpleEvaluation) instances. * **Parameters:** * **pred_field** – the name of the field containing the predicted [`fiftyone.core.labels.Regression`](fiftyone.core.labels.md#fiftyone.core.labels.Regression) instances * **gt_field** – the name of the field containing the ground truth [`fiftyone.core.labels.Regression`](fiftyone.core.labels.md#fiftyone.core.labels.Regression) instances * **metric** ( *"squared_error"*) – the error metric to use to populate sample/frame-level error data. Supported values are `("squared_error", "absolute_error")` or any function that accepts two scalar arguments `(ypred, ytrue)` * **custom_metrics** (*None*) – an optional list of custom metrics to compute or dict mapping metric names to kwargs dicts **Attributes:** | [`method`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.method) | The name of the method. | |-----------------------------------------------------------------------------|---------------------------------------------------------| | [`metric`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.metric) | | | [`cls`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.cls) | The fully-qualified name of this `BaseRunConfig` class. | | [`run_cls`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.run_cls) | The `BaseRun` class associated with this config. | | [`type`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.type) | The type of run. | **Methods:** | [`attributes`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.attributes)() | Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.serialize). | |-------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| | [`base_config_cls`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.base_config_cls)(type) | Returns the config class for the given run type. | | [`build`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.build)() | Builds the `BaseRun` instance associated with this config. | | [`builder`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.builder)() | Returns a ConfigBuilder instance for this class. | | [`copy`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.copy)() | Returns a deep copy of the object. | | [`custom_attributes`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.custom_attributes)([dynamic, private]) | Returns a customizable list of class attributes. | | [`default`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.default)() | Returns the default config instance. | | [`from_dict`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.from_dict)(d) | Constructs a `BaseRunConfig` from a serialized JSON dict representation of it. | | [`from_json`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.from_json)(path, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON file. | | [`from_kwargs`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.from_kwargs)(\*\*kwargs) | Constructs a Config object from keyword arguments. | | [`from_str`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.from_str)(s, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON string. | | [`get_class_name`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.get_class_name)() | Returns the fully-qualified class name string of this object. | | [`load_credentials`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.load_credentials)(\*\*kwargs) | Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config. | | [`load_default`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.load_default)() | Loads the default config instance from file. | | [`parse_array`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_array)(d, key[, default]) | Parses a raw array attribute. | | [`parse_bool`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_bool)(d, key[, default]) | Parses a boolean value. | | [`parse_categorical`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.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.regression.SimpleEvaluationConfig.parse_dict)(d, key[, default]) | Parses a dictionary attribute. | | [`parse_int`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_int)(d, key[, default]) | Parses an integer attribute. | | [`parse_mutually_exclusive_fields`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.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.regression.SimpleEvaluationConfig.parse_number)(d, key[, default]) | Parses a number attribute. | | [`parse_object`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_object)(d, key, cls[, default]) | Parses an object attribute. | | [`parse_object_array`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_object_array)(d, key, cls[, default]) | Parses an array of objects. | | [`parse_object_dict`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_object_dict)(d, key, cls[, default]) | Parses a dictionary whose values are objects. | | [`parse_path`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_path)(d, key[, default]) | Parses a path attribute. | | [`parse_raw`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_raw)(d, key[, default]) | Parses a raw (arbitrary) JSON field. | | [`parse_string`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_string)(d, key[, default]) | Parses a string attribute. | | [`serialize`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.serialize)([reflective]) | Serializes the object into a dictionary. | | [`to_str`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.to_str)([pretty_print]) | Returns a string representation of this object. | | [`validate_all_or_nothing_fields`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.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.regression.SimpleEvaluationConfig.write_json)(path[, pretty_print]) | Serializes the object and writes it to disk. | #### *property* method The name of the method. #### *property* metric #### attributes() Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig.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. #### *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.regression.SimpleEvaluation(config) Bases: [`RegressionEvaluation`](#fiftyone.utils.eval.regression.RegressionEvaluation) Simple regression evaluation. * **Parameters:** **config** – a [`SimpleEvaluationConfig`](#fiftyone.utils.eval.regression.SimpleEvaluationConfig) **Methods:** | [`evaluate_samples`](#fiftyone.utils.eval.regression.SimpleEvaluation.evaluate_samples)(samples[, eval_key, ...]) | Evaluates the regression predictions in the given samples with respect to the specified ground truth values. | |----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| | [`add_fields_to_sidebar_group`](#fiftyone.utils.eval.regression.SimpleEvaluation.add_fields_to_sidebar_group)(samples, eval_key) | | | [`cleanup`](#fiftyone.utils.eval.regression.SimpleEvaluation.cleanup)(samples, eval_key) | Cleans up the results of the run with the given key from the collection. | | [`cleanup_custom_metrics`](#fiftyone.utils.eval.regression.SimpleEvaluation.cleanup_custom_metrics)(samples, eval_key[, ...]) | | | [`compute_custom_metrics`](#fiftyone.utils.eval.regression.SimpleEvaluation.compute_custom_metrics)(samples, eval_key, ...) | | | [`delete_run`](#fiftyone.utils.eval.regression.SimpleEvaluation.delete_run)(samples, key[, cleanup]) | Deletes the results associated with the given run key from the collection. | | [`delete_runs`](#fiftyone.utils.eval.regression.SimpleEvaluation.delete_runs)(samples[, cleanup]) | Deletes all runs from the collection. | | [`ensure_requirements`](#fiftyone.utils.eval.regression.SimpleEvaluation.ensure_requirements)() | Ensures that any necessary packages to execute this run are installed. | | [`ensure_usage_requirements`](#fiftyone.utils.eval.regression.SimpleEvaluation.ensure_usage_requirements)() | Ensures that any necessary packages to use existing results for this run are installed. | | [`from_config`](#fiftyone.utils.eval.regression.SimpleEvaluation.from_config)(config) | Instantiates a Configurable class from a Config instance. | | [`from_dict`](#fiftyone.utils.eval.regression.SimpleEvaluation.from_dict)(d) | Instantiates a Configurable class from a Config dict. | | [`from_json`](#fiftyone.utils.eval.regression.SimpleEvaluation.from_json)(json_path) | Instantiates a Configurable class from a Config JSON file. | | [`from_kwargs`](#fiftyone.utils.eval.regression.SimpleEvaluation.from_kwargs)(\*\*kwargs) | Instantiates a Configurable class from keyword arguments defining the attributes of a Config. | | [`get_custom_metric_fields`](#fiftyone.utils.eval.regression.SimpleEvaluation.get_custom_metric_fields)(samples, eval_key) | | | [`get_fields`](#fiftyone.utils.eval.regression.SimpleEvaluation.get_fields)(samples, eval_key[, ...]) | Gets the fields that were involved in the given run. | | [`get_run_info`](#fiftyone.utils.eval.regression.SimpleEvaluation.get_run_info)(samples, key) | Gets the `BaseRunInfo` for the given key on the collection. | | [`has_cached_run_results`](#fiftyone.utils.eval.regression.SimpleEvaluation.has_cached_run_results)(samples, key) | Determines whether `BaseRunResults` for the given key are cached on the collection. | | [`list_runs`](#fiftyone.utils.eval.regression.SimpleEvaluation.list_runs)(samples[, type, method]) | Returns the list of run keys on the given collection. | | [`load_run_results`](#fiftyone.utils.eval.regression.SimpleEvaluation.load_run_results)(samples, key[, cache, ...]) | Loads the `BaseRunResults` for the given key on the collection. | | [`load_run_view`](#fiftyone.utils.eval.regression.SimpleEvaluation.load_run_view)(samples, key[, select_fields]) | Loads the view on which the specified run was performed. | | [`parse`](#fiftyone.utils.eval.regression.SimpleEvaluation.parse)(class_name[, module_name]) | Parses a Configurable subclass name string. | | [`register_run`](#fiftyone.utils.eval.regression.SimpleEvaluation.register_run)(samples, key[, overwrite, cleanup]) | Registers a run of this method under the given key on the given collection. | | [`register_samples`](#fiftyone.utils.eval.regression.SimpleEvaluation.register_samples)(samples, eval_key) | Registers the collection on which evaluation will be performed. | | [`rename`](#fiftyone.utils.eval.regression.SimpleEvaluation.rename)(samples, eval_key, new_eval_key) | Performs any necessary operations required to rename this run's key. | | [`rename_custom_metrics`](#fiftyone.utils.eval.regression.SimpleEvaluation.rename_custom_metrics)(samples, eval_key, ...) | | | [`run_info_cls`](#fiftyone.utils.eval.regression.SimpleEvaluation.run_info_cls)() | The `BaseRunInfo` class associated with this class. | | [`save_run_info`](#fiftyone.utils.eval.regression.SimpleEvaluation.save_run_info)(samples, run_info[, ...]) | Saves the run information on the collection. | | [`save_run_results`](#fiftyone.utils.eval.regression.SimpleEvaluation.save_run_results)(samples, key, run_results) | Saves the run results on the collection. | | [`update_run_config`](#fiftyone.utils.eval.regression.SimpleEvaluation.update_run_config)(samples, key, config) | Updates the `BaseRunConfig` for the given run on the collection. | | [`update_run_key`](#fiftyone.utils.eval.regression.SimpleEvaluation.update_run_key)(samples, key, new_key) | Replaces the key for the given run with a new key. | | [`validate`](#fiftyone.utils.eval.regression.SimpleEvaluation.validate)(config) | Validates that the given config is an instance of Config. | | [`validate_run`](#fiftyone.utils.eval.regression.SimpleEvaluation.validate_run)(samples, key[, overwrite]) | Validates that the collection can accept this run. | #### evaluate_samples(samples, eval_key=None, missing=None, progress=None) Evaluates the regression predictions in the given samples with respect to the specified ground truth values. * **Parameters:** * **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) * **eval_key** (*None*) – an evaluation key for this evaluation * **missing** (*None*) – a missing value. Any None-valued regressions are given this value for results purposes * **progress** (*None*) – whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead * **Returns:** a [`RegressionResults`](#fiftyone.utils.eval.regression.RegressionResults) instance #### add_fields_to_sidebar_group(samples, eval_key, omit_fields=None) #### cleanup(samples, eval_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 #### cleanup_custom_metrics(samples, eval_key, metric_uris=None) #### compute_custom_metrics(samples, eval_key, results, metric_uris=None) #### *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 #### get_custom_metric_fields(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 #### *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 #### register_samples(samples, eval_key) Registers the collection on which evaluation will be performed. This method will be called before calling [`evaluate_samples()`](#fiftyone.utils.eval.regression.SimpleEvaluation.evaluate_samples). Subclasses can extend this method to perform any setup required for an evaluation run. * **Parameters:** * **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) * **eval_key** – the evaluation key for this evaluation #### rename(samples, eval_key, new_eval_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 #### rename_custom_metrics(samples, eval_key, new_eval_key, metric_uris=None) #### *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.regression.RegressionResults(samples, config, eval_key, ytrue, ypred, confs=None, ids=None, missing=None, custom_metrics=None, backend=None) Bases: [`BaseEvaluationResults`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults) Class that stores the results of a regression evaluation. * **Parameters:** * **samples** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) used * **config** – the [`RegressionEvaluationConfig`](#fiftyone.utils.eval.regression.RegressionEvaluationConfig) used * **eval_key** (*None*) – the evaluation key * **ytrue** – a list of ground truth values * **ypred** – a list of predicted values * **confs** (*None*) – an optional list of confidences for the predictions * **eval_key** – the evaluation key of the evaluation * **gt_field** (*None*) – the name of the ground truth field * **pred_field** (*None*) – the name of the predictions field * **ids** (*None*) – a list of sample or frame IDs corresponding to the regressions * **missing** (*None*) – a missing value. Any None-valued regressions are given this value for results purposes * **custom_metrics** (*None*) – an optional dict of custom metrics * **backend** (*None*) – a [`RegressionEvaluation`](#fiftyone.utils.eval.regression.RegressionEvaluation) backend **Methods:** | [`metrics`](#fiftyone.utils.eval.regression.RegressionResults.metrics)([weights]) | Computes various popular regression metrics for the results. | |---------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| | [`print_metrics`](#fiftyone.utils.eval.regression.RegressionResults.print_metrics)([weights, digits]) | Prints the metrics computed via [`metrics()`](#fiftyone.utils.eval.regression.RegressionResults.metrics). | | [`plot_results`](#fiftyone.utils.eval.regression.RegressionResults.plot_results)([labels, sizes, backend]) | Plots the regression results. | | [`add_custom_metrics`](#fiftyone.utils.eval.regression.RegressionResults.add_custom_metrics)(custom_metrics[, overwrite]) | Computes the given custom metrics and adds them to these results. | | [`attributes`](#fiftyone.utils.eval.regression.RegressionResults.attributes)() | Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.utils.eval.regression.RegressionResults.serialize). | | [`base_results_cls`](#fiftyone.utils.eval.regression.RegressionResults.base_results_cls)(type) | Returns the results class for the given run type. | | [`copy`](#fiftyone.utils.eval.regression.RegressionResults.copy)() | Returns a deep copy of the object. | | [`custom_attributes`](#fiftyone.utils.eval.regression.RegressionResults.custom_attributes)([dynamic, private]) | Returns a customizable list of class attributes. | | [`from_dict`](#fiftyone.utils.eval.regression.RegressionResults.from_dict)(d, samples, config, key) | Builds a `BaseRunResults` from a JSON dict representation of it. | | [`from_json`](#fiftyone.utils.eval.regression.RegressionResults.from_json)(path, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON file. | | [`from_str`](#fiftyone.utils.eval.regression.RegressionResults.from_str)(s, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON string. | | [`get_class_name`](#fiftyone.utils.eval.regression.RegressionResults.get_class_name)() | Returns the fully-qualified class name string of this object. | | [`get_meta`](#fiftyone.utils.eval.regression.RegressionResults.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.regression.RegressionResults.save)() | Saves the results to the database. | | [`save_config`](#fiftyone.utils.eval.regression.RegressionResults.save_config)() | Saves these results config to the database. | | [`serialize`](#fiftyone.utils.eval.regression.RegressionResults.serialize)([reflective]) | Serializes the object into a dictionary. | | [`to_str`](#fiftyone.utils.eval.regression.RegressionResults.to_str)([pretty_print]) | Returns a string representation of this object. | | [`write_json`](#fiftyone.utils.eval.regression.RegressionResults.write_json)(path[, pretty_print]) | Serializes the object and writes it to disk. | **Attributes:** | [`backend`](#fiftyone.utils.eval.regression.RegressionResults.backend) | The `BaseRun` for these results. | |--------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`cls`](#fiftyone.utils.eval.regression.RegressionResults.cls) | The fully-qualified name of this `BaseRunResults` class. | | [`config`](#fiftyone.utils.eval.regression.RegressionResults.config) | The `BaseRunConfig` for these results. | | [`key`](#fiftyone.utils.eval.regression.RegressionResults.key) | The run key for these results. | | [`samples`](#fiftyone.utils.eval.regression.RegressionResults.samples) | The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) associated with these results. | #### metrics(weights=None) Computes various popular regression metrics for the results. The computed metrics are: - Mean squared error: [`sklearn.metrics.mean_squared_error()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.mean_squared_error.html#sklearn.metrics.mean_squared_error) - Root mean squared error: [`sklearn.metrics.mean_squared_error()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.mean_squared_error.html#sklearn.metrics.mean_squared_error) - Mean absolute error: [`sklearn.metrics.mean_absolute_error()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.mean_absolute_error.html#sklearn.metrics.mean_absolute_error) - Median absolute error: [`sklearn.metrics.median_absolute_error()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.median_absolute_error.html#sklearn.metrics.median_absolute_error) - R^2 score: [`sklearn.metrics.r2_score()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.r2_score.html#sklearn.metrics.r2_score) - Explained variance score: [`sklearn.metrics.explained_variance_score()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.explained_variance_score.html#sklearn.metrics.explained_variance_score) - Max error: [`sklearn.metrics.max_error()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.max_error.html#sklearn.metrics.max_error) - Support: the number of examples Also includes any custom metrics from `custom_metrics`. * **Parameters:** **weights** (*None*) – an optional list of weights for each example * **Returns:** a dict #### print_metrics(weights=None, digits=2) Prints the metrics computed via [`metrics()`](#fiftyone.utils.eval.regression.RegressionResults.metrics). * **Parameters:** * **weights** (*None*) – an optional list of weights for each example * **digits** (*2*) – the number of digits of precision to print #### plot_results(labels=None, sizes=None, backend='plotly', \*\*kwargs) Plots the regression results. You can use the `labels` parameters to define a coloring for the points, and you can use the `sizes` parameter to scale the sizes of the points. You can attach plots generated by this method 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 points in the plot. * **Parameters:** * **labels** (*None*) – data to use to color the points. Can be any of the following: - the name of a sample field or `embedded.field.name` of from which to extract numeric or string values - a [`fiftyone.core.expressions.ViewExpression`](fiftyone.core.expressions.md#fiftyone.core.expressions.ViewExpression) defining numeric or string values to extract via [`fiftyone.core.collections.SampleCollection.values()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.values) - a list or array-like of numeric or string values (or lists of lists for frame-level regressions) * **sizes** (*None*) – data to use to scale the sizes of the points. Can be any of the following: - the name of a sample field or `embedded.field.name` from which to extract numeric values - a [`fiftyone.core.expressions.ViewExpression`](fiftyone.core.expressions.md#fiftyone.core.expressions.ViewExpression) defining numeric values to extract via [`fiftyone.core.collections.SampleCollection.values()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.values) - a list or array-like of numeric values (or lists of lists for frame-level regressions) * **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_regressions()`](fiftyone.core.plots.plotly.md#fiftyone.core.plots.plotly.plot_regressions) - ”matplotlib” backend: [`fiftyone.core.plots.matplotlib.plot_regressions()`](fiftyone.core.plots.matplotlib.md#fiftyone.core.plots.matplotlib.plot_regressions) * **Returns:** an [`fiftyone.core.plots.base.InteractivePlot`](fiftyone.core.plots.base.md#fiftyone.core.plots.base.InteractivePlot) #### 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.regression.RegressionResults.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()`