fiftyone.utils.eval.regression.SimpleEvaluationConfig

class documentation

class SimpleEvaluationConfig(RegressionEvaluationConfig): (source)

Constructor: SimpleEvaluationConfig(pred_field, gt_field, metric, custom_metrics, **kwargs)

View In Hierarchy

Base class for configuring SimpleEvaluation instances.

Parameters
pred_fieldthe name of the field containing the predicted fiftyone.core.labels.Regression instances
gt_fieldthe name of the field containing the ground truth fiftyone.core.labels.Regression instances
metricthe 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_metricsan optional list of custom metrics to compute or dict mapping metric names to kwargs dicts
Method __init__ Undocumented
Method attributes Returns the list of class attributes that will be serialized by serialize.
Property method The name of the method.
Property metric Undocumented
Instance Variable _metric Undocumented

Inherited from RegressionEvaluationConfig:

Instance Variable gt_field Undocumented
Instance Variable pred_field Undocumented
Property type The type of run.

Inherited from BaseRunConfig (via RegressionEvaluationConfig, BaseEvaluationMethodConfig, EvaluationMethodConfig):

Class Method from_dict Constructs a BaseRunConfig from a serialized JSON dict representation of it.
Static Method base_config_cls Returns the config class for the given run type.
Method build Builds the BaseRun instance associated with this config.
Method load_credentials Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config.
Property cls The fully-qualified name of this BaseRunConfig class.
Property run_cls The BaseRun class associated with this config.
Class Method _virtual_attributes A list of attributes that are serialized but should not be treated as parameters when loading the config class from the database.

Inherited from Config (via RegressionEvaluationConfig, BaseEvaluationMethodConfig, EvaluationMethodConfig, BaseRunConfig):

Method __repr__ Undocumented
def __init__(self, pred_field, gt_field, metric='squared_error', custom_metrics=None, **kwargs): (source)
overrides fiftyone.utils.eval.regression.RegressionEvaluationConfig.__init__

Undocumented

def attributes(self): (source)
overrides fiftyone.core.runs.BaseRunConfig.attributes

Returns the list of class attributes that will be serialized by serialize.

Returns
a list of attributes
@property
method = (source)
overrides fiftyone.core.evaluation.EvaluationMethodConfig.method

The name of the method.

@property
metric = (source)

Undocumented

_metric = (source)

Undocumented