fiftyone.utils.eval.segmentation.SegmentationResults

class documentation

class SegmentationResults(BaseClassificationResults): (source)

Constructor: SegmentationResults(samples, config, eval_key, pixel_confusion_matrix, ...)

Class that stores the results of a segmentation evaluation.

Parameters
samples	the `fiftyone.core.collections.SampleCollection` used
config	the `SegmentationEvaluationConfig` used
eval_key	the evaluation key
pixel_confusion_matrix	a pixel value confusion matrix
classes	a list of class labels corresponding to the confusion matrix
matches	a list of `(gt_label, pred_label, pixel_count, gt_id, pred_id)` matches
missing	a missing (background) class
custom_metrics	an optional dict of custom metrics
backend	a `SegmentationEvaluation` backend

Method	`__init__`	Undocumented
Method	`dice_score`	Computes the Dice score across all samples in the evaluation.
Instance Variable	`pixel_confusion_matrix`	Undocumented
Class Method	`_from_dict`	Subclass implementation of `from_dict`.
Static Method	`_parse_confusion_matrix`	Undocumented

Inherited from BaseClassificationResults:

Method	`__enter__`	Undocumented
Method	`__exit__`	Undocumented
Method	`clear_subset`	Clears the subset set by `use_subset`, if any.
Method	`confusion_matrix`	Generates a confusion matrix for the results via `sklearn:sklearn.metrics.confusion_matrix`.
Method	`metrics`	Computes classification metrics for the results, including accuracy, precision, recall, and F-beta score.
Method	`plot_confusion_matrix`	Plots a confusion matrix for the evaluation results.
Method	`print_metrics`	Prints the metrics computed via `metrics`.
Method	`print_report`	Prints a classification report for the results via `sklearn:sklearn.metrics.classification_report`.
Method	`report`	Generates a classification report for the results via `sklearn:sklearn.metrics.classification_report`.
Method	`use_subset`	Restricts the evaluation results to the specified subset.
Instance Variable	`classes`	Undocumented
Instance Variable	`confs`	Undocumented
Instance Variable	`weights`	Undocumented
Instance Variable	`ypred`	Undocumented
Instance Variable	`ypred_ids`	Undocumented
Instance Variable	`ytrue`	Undocumented
Instance Variable	`ytrue_ids`	Undocumented
Property	`has_subset`	Whether these results are currently restricted to a subset via `use_subset`.
Method	`_confusion_matrix`	Undocumented
Method	`_parse_classes`	Undocumented
Instance Variable	`_confs_orig`	Undocumented
Instance Variable	`_has_subset`	Undocumented
Instance Variable	`_samples`	Undocumented
Instance Variable	`_samples_orig`	Undocumented
Instance Variable	`_weights_orig`	Undocumented
Instance Variable	`_ypred_ids_orig`	Undocumented
Instance Variable	`_ypred_orig`	Undocumented
Instance Variable	`_ytrue_ids_orig`	Undocumented
Instance Variable	`_ytrue_orig`	Undocumented

Inherited from BaseEvaluationResults (via BaseClassificationResults):

Method	`add_custom_metrics`	Computes the given custom metrics and adds them to these results.
Method	`_get_custom_metrics`	Undocumented
Method	`_print_metrics`	Undocumented

Inherited from BaseRunResults (via BaseClassificationResults, BaseEvaluationResults, EvaluationResults):

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.
Instance Variable	`_backend`	Undocumented
Instance Variable	`_config`	Undocumented
Instance Variable	`_key`	Undocumented

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

overrides fiftyone.utils.eval.base.BaseClassificationResults.__init__

Undocumented

def dice_score(self): (source) ¶

Computes the Dice score across all samples in the evaluation.

Returns
the Dice score in `[0, 1]`

pixel_confusion_matrix = (source) ¶

Undocumented

@classmethod
def _from_dict(cls, d, samples, config, eval_key, **kwargs): (source) ¶

overrides fiftyone.utils.eval.base.BaseClassificationResults._from_dict

Subclass implementation of from_dict.

Parameters
d	a JSON dict
samples	the `fiftyone.core.collections.SampleCollection` for the run
config	the `BaseRunConfig` for the run
eval_key	Undocumented
key	the run key
**kwargs	Undocumented
Returns
a `BaseRunResults`

@staticmethod
def _parse_confusion_matrix(confusion_matrix, classes): (source) ¶

Undocumented