fiftyone.utils.eval.segmentation.SimpleEvaluationConfig

class documentation

class SimpleEvaluationConfig(SegmentationEvaluationConfig): (source)

Constructor: SimpleEvaluationConfig(pred_field, gt_field, compute_dice, bandwidth, ...)

View In Hierarchy

Class for configuring SimpleEvaluation instances.

Parameters
pred_fieldthe name of the field containing the predicted fiftyone.core.labels.Segmentation instances
gt_fieldthe name of the field containing the ground truth fiftyone.core.labels.Segmentation instances
compute_dicewhether to compute the Dice coefficient for each sample
bandwidthan optional bandwidth along the contours of the ground truth masks to which to restrict attention when computing accuracies. A typical value for this parameter is 5 pixels. By default, the entire masks are evaluated
averagethe averaging strategy to use when populating precision and recall numbers on each sample
custom_metricsan optional list of custom metrics to compute or dict mapping metric names to kwargs dicts
Method __init__ Undocumented
Instance Variable average Undocumented
Instance Variable bandwidth Undocumented
Property method The name of the method.

Inherited from SegmentationEvaluationConfig:

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

Inherited from BaseRunConfig (via SegmentationEvaluationConfig, 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 attributes Returns the list of class attributes that will be serialized by serialize.
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 SegmentationEvaluationConfig, BaseEvaluationMethodConfig, EvaluationMethodConfig, BaseRunConfig):

Method __repr__ Undocumented
def __init__(self, pred_field, gt_field, compute_dice=False, bandwidth=None, average='micro', custom_metrics=None, **kwargs): (source)
overrides fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.__init__

Undocumented

average: "micro" = (source)

Undocumented

bandwidth: None = (source)

Undocumented

@property
method = (source)
overrides fiftyone.core.evaluation.EvaluationMethodConfig.method

The name of the method.