fiftyone.utils.eval.base.BaseEvaluationResults

class documentation

class BaseEvaluationResults(foe.EvaluationResults): (source)

Base class for evaluation results.

Parameters
samples	the `fiftyone.core.collections.SampleCollection` used
config	the `BaseEvaluationMethodConfig` used
eval_key	the evaluation key
custom_metrics	an optional dict of custom metrics
backend	an `EvaluationMethod` backend

Method	`__init__`	Undocumented
Method	`metrics`	Returns the metrics associated with this evaluation run.
Method	`print_metrics`	Prints the metrics computed via `metrics`.
Instance Variable	`custom_metrics`	Undocumented
Method	`_get_custom_metrics`	Undocumented
Method	`_print_metrics`	Undocumented

Class Method	`from_dict`	Builds a `BaseRunResults` from a JSON dict representation of it.
Static Method	`base_results_cls`	Returns the results class for the given run type.
Method	`attributes`	Returns the list of class attributes that will be serialized by `serialize`.
Method	`save`	Saves the results to the database.
Method	`save_config`	Saves these results config to the database.
Property	`cls`	The fully-qualified name of this `BaseRunResults` class.
Property	`config`	The `BaseRunConfig` for these results.
Property	`key`	The run key for these results.
Property	`samples`	The `fiftyone.core.collections.SampleCollection` associated with these results.
Class Method	`_from_dict`	Subclass implementation of `from_dict`.
Instance Variable	`_backend`	Undocumented
Instance Variable	`_config`	Undocumented
Instance Variable	`_key`	Undocumented
Instance Variable	`_samples`	Undocumented

def __init__(self, samples, config, eval_key, custom_metrics=None, backend=None): (source) ¶

overrides fiftyone.core.runs.BaseRunResults.__init__

overridden in fiftyone.utils.eval.base.BaseClassificationResults, fiftyone.utils.eval.regression.RegressionResults

Undocumented

def metrics(self, *args, **kwargs): (source) ¶

overridden in fiftyone.utils.eval.base.BaseClassificationResults, fiftyone.utils.eval.regression.RegressionResults

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

def print_metrics(self, *args, digits=2, **kwargs): (source) ¶

overridden in fiftyone.utils.eval.base.BaseClassificationResults, fiftyone.utils.eval.regression.RegressionResults

Prints the metrics computed via metrics.

Parameters
*args	subclass-specific positional arguments
digits:2	the number of digits of precision to print
**kwargs	subclass-specific keyword argument

overridden in fiftyone.utils.eval.base.BaseClassificationResults, fiftyone.utils.eval.regression.RegressionResults

Undocumented

def _get_custom_metrics(self): (source) ¶

Undocumented

def _print_metrics(self, metrics, digits=2): (source) ¶

Undocumented