fiftyone.operators.evaluation_metric.EvaluationMetricConfig

class documentation

class EvaluationMetricConfig(OperatorConfig): (source)

Constructor: EvaluationMetricConfig(name, label, description, eval_types, ...)

View In Hierarchy

Configuration class for evaluation metrics.

Parameters
namethe name of the evaluation metric
labela label for the evaluation metric
descriptiona description of the evaluation metric
eval_typesan optional list of evaluation method types that this metric supports
aggregate_keyan optional key under which to store the metric's aggregate value. This is used, for example, by metrics(). By default, the metric's name is used as its key
lower_is_betterwhether lower values of the metric are better
**kwargsother kwargs for fiftyone.operators.OperatorConfig
Method __init__ Undocumented
Instance Variable aggregate_key Undocumented
Instance Variable eval_types Undocumented
Instance Variable lower_is_better Undocumented

Inherited from OperatorConfig:

Method to_json Undocumented
Instance Variable allow_delegated_execution Undocumented
Instance Variable allow_immediate_execution Undocumented
Instance Variable dark_icon Undocumented
Instance Variable default_choice_to_delegated Undocumented
Instance Variable delegation_target Undocumented
Instance Variable disable_schema_validation Undocumented
Instance Variable dynamic Undocumented
Instance Variable execute_as_generator Undocumented
Instance Variable icon Undocumented
Instance Variable kwargs Undocumented
Instance Variable light_icon Undocumented
Instance Variable name Undocumented
Instance Variable on_dataset_open Undocumented
Instance Variable on_startup Undocumented
Instance Variable resolve_execution_options_on_change Undocumented
Instance Variable unlisted Undocumented
def __init__(self, name, label=None, description=None, eval_types=None, aggregate_key=None, lower_is_better=True, **kwargs): (source)
overrides fiftyone.operators.operator.OperatorConfig.__init__

Undocumented

aggregate_key: None = (source)

Undocumented

eval_types: None = (source)

Undocumented

lower_is_better: True = (source)

Undocumented