fiftyone.utils.eval.coco.COCOEvaluationConfig

class documentation

class COCOEvaluationConfig(DetectionEvaluationConfig): (source)

Constructor: COCOEvaluationConfig(pred_field, gt_field, iou, classwise, ...)

COCO-style evaluation config.

Parameters
pred_field	the name of the field containing the predicted `fiftyone.core.labels.Detections`, `fiftyone.core.labels.Polylines`, or `fiftyone.core.labels.Keypoints`
gt_field	the name of the field containing the ground truth `fiftyone.core.labels.Detections`, `fiftyone.core.labels.Polylines`, or `fiftyone.core.labels.Keypoints`
iou	the IoU threshold to use to determine matches
classwise	whether to only match objects with the same class label (True) or allow matches between classes (False)
iscrowd	the name of the crowd attribute
use_masks	whether to compute IoUs using the instances masks in the `mask` attribute of the provided objects, which must be `fiftyone.core.labels.Detection` instances
use_boxes	whether to compute IoUs using the bounding boxes of the provided `fiftyone.core.labels.Polyline` instances rather than using their actual geometries
tolerance	a tolerance, in pixels, when generating approximate polylines for instance masks. Typical values are 1-3 pixels
compute_mAP	whether to perform the necessary computations so that mAP, mAR, and PR curves can be generated
iou_threshs	a list of IoU thresholds to use when computing mAP and PR curves. Only applicable when `compute_mAP` is True
max_preds	the maximum number of predicted objects to evaluate when computing mAP and PR curves. Only applicable when `compute_mAP` is True
error_level	the error level to use when manipulating instance masks or polylines. Valid values are: 0: raise geometric errors that are encountered 1: log warnings if geometric errors are encountered 2: ignore geometric errors If `error_level > 0`, any calculation that raises a geometric error will default to an IoU of 0
custom_metrics	an optional list of custom metrics to compute or dict mapping metric names to kwargs dicts

Method	`__init__`	Undocumented
Instance Variable	`compute_mAP`	Undocumented
Instance Variable	`error_level`	Undocumented
Instance Variable	`iou_threshs`	Undocumented
Instance Variable	`iscrowd`	Undocumented
Instance Variable	`max_preds`	Undocumented
Instance Variable	`tolerance`	Undocumented
Instance Variable	`use_boxes`	Undocumented
Instance Variable	`use_masks`	Undocumented
Property	`method`	The name of the method.

Inherited from DetectionEvaluationConfig:

Instance Variable	`gt_field`	Undocumented
Instance Variable	`pred_field`	Undocumented
Property	`requires_additional_fields`	Whether fields besides `pred_field` and `gt_field` are required in order to perform evaluation.
Property	`type`	The type of run.

Inherited from BaseRunConfig (via DetectionEvaluationConfig, 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 DetectionEvaluationConfig, BaseEvaluationMethodConfig, EvaluationMethodConfig, BaseRunConfig):

Method __repr__ Undocumented

def __init__(self, pred_field, gt_field, iou=None, classwise=None, iscrowd='iscrowd', use_masks=False, use_boxes=False, tolerance=None, compute_mAP=False, iou_threshs=None, max_preds=None, error_level=1, custom_metrics=None, **kwargs): (source) ¶

overrides fiftyone.utils.eval.detection.DetectionEvaluationConfig.__init__

Undocumented

compute_mAP: False = (source) ¶

Undocumented

error_level: 1 = (source) ¶

Undocumented

iou_threshs: None = (source) ¶

Undocumented

iscrowd: "iscrowd" = (source) ¶

Undocumented

max_preds: None = (source) ¶

Undocumented