class documentation

Standard pixelwise segmentation evaluation.

This class can optionally be configured to evaluate along only the boundaries of the ground truth segmentation masks.

Parameters
configa SimpleEvaluationConfig
Method evaluate_samples Evaluates the predicted segmentation masks in the given samples with respect to the specified ground truth masks.

Inherited from SegmentationEvaluation:

Method cleanup Cleans up the results of the run with the given key from the collection.
Method get_fields Gets the fields that were involved in the given run.
Method register_samples Registers the collection on which evaluation will be performed.
Method rename Performs any necessary operations required to rename this run's key.
Method _validate_run Subclass-specific validation when a run with the given key already exists.

Inherited from BaseEvaluationMethod (via SegmentationEvaluation):

Method cleanup_custom_metrics Undocumented
Method compute_custom_metrics Undocumented
Method get_custom_metric_fields Undocumented
Method rename_custom_metrics Undocumented
Method _get_custom_metrics Undocumented

Inherited from EvaluationMethod (via SegmentationEvaluation, BaseEvaluationMethod):

Class Method run_info_cls The BaseRunInfo class associated with this class.
Class Method _patch_function A function that can patch any ReferenceField issues with a dataset's runs.
Class Method _results_cache_field The fiftyone.core.dataset.Dataset field that stores the results cache for these runs.
Class Method _run_str A string to use when referring to these runs in log messages.
Class Method _runs_field The fiftyone.core.odm.dataset.DatasetDocument field in which these runs are stored.

Inherited from BaseRun (via SegmentationEvaluation, BaseEvaluationMethod, EvaluationMethod):

Class Method delete_run Deletes the results associated with the given run key from the collection.
Class Method delete_runs Deletes all runs from the collection.
Class Method get_run_info Gets the BaseRunInfo for the given key on the collection.
Class Method has_cached_run_results Determines whether BaseRunResults for the given key are cached on the collection.
Class Method list_runs Returns the list of run keys on the given collection.
Class Method load_run_results Loads the BaseRunResults for the given key on the collection.
Class Method load_run_view Loads the fiftyone.core.view.DatasetView on which the specified run was performed.
Class Method save_run_info Saves the run information on the collection.
Class Method save_run_results Saves the run results on the collection.
Class Method update_run_config Updates the BaseRunConfig for the given run on the collection.
Class Method update_run_key Replaces the key for the given run with a new key.
Method ensure_requirements Ensures that any necessary packages to execute this run are installed.
Method ensure_usage_requirements Ensures that any necessary packages to use existing results for this run are installed.
Method register_run Registers a run of this method under the given key on the given collection.
Method validate_run Validates that the collection can accept this run.
Class Method _get_run_doc Undocumented
Class Method _get_run_docs Undocumented
Class Method _get_run_fields Undocumented
Method _validate_fields_match Undocumented

Inherited from Configurable (via SegmentationEvaluation, BaseEvaluationMethod, EvaluationMethod, BaseRun):

Method __init__ Undocumented
Instance Variable config Undocumented
def evaluate_samples(self, samples, eval_key=None, mask_targets=None, progress=None): (source) ΒΆ

Evaluates the predicted segmentation masks in the given samples with respect to the specified ground truth masks.

Parameters
samplesa fiftyone.core.collections.SampleCollection
eval_key:Nonean evaluation key for this evaluation
mask_targets:Nonea dict mapping mask values to labels. May contain a subset of the possible classes if you wish to evaluate a subset of the semantic classes. By default, the observed pixel values are used as labels
progress:Nonewhether to render a progress bar (True/False), use the default value fiftyone.config.show_progress_bars (None), or a progress callback function to invoke instead
Returns
a SegmentationResults instance