fiftyone.core.stages.ToEvaluationPatches

class documentation

class ToEvaluationPatches(ViewStage): (source)

Constructor: ToEvaluationPatches(eval_key, config, _state, **kwargs)

Creates a view based on the results of the evaluation with the given key that contains one sample for each true positive, false positive, and false negative example in the collection, respectively.

True positive examples will result in samples with both their ground truth and predicted fields populated, while false positive/negative examples wilL only have one of their corresponding predicted/ground truth fields populated, respectively.

If multiple predictions are matched to a ground truth object (e.g., if the evaluation protocol includes a crowd attribute), then all matched predictions will be stored in the single sample along with the ground truth object.

The returned dataset will also have top-level type and iou fields populated based on the evaluation results for that example, as well as a sample_id field recording the sample ID of the example, and a crowd field if the evaluation protocol defines a crowd attribute.

Note

The returned view will contain patches for the contents of this collection, which may differ from the view on which the eval_key evaluation was performed. This may exclude some labels that were evaluated and/or include labels that were not evaluated.

If you would like to see patches for the exact view on which an evaluation was performed, first call load_evaluation_view() to load the view and then convert to patches.

Examples:

import fiftyone as fo
import fiftyone.zoo as foz

dataset = foz.load_zoo_dataset("quickstart")
dataset.evaluate_detections("predictions", eval_key="eval")

session = fo.launch_app(dataset)

#
# Create a patches view for the evaluation results
#

stage = fo.ToEvaluationPatches("eval")
view = dataset.add_stage(stage)
print(view)

session.view = view

Parameters
eval_key	an evaluation key that corresponds to the evaluation of ground truth/predicted fields that are of type `fiftyone.core.labels.Detections`, fiftyone.core.labels.Polylines, or `fiftyone.core.labels.Keypoints
config	an optional dict of keyword arguments for `fiftyone.core.patches.make_evaluation_patches_dataset` specifying how to perform the conversion
**kwargs	optional keyword arguments for `fiftyone.core.patches.make_evaluation_patches_dataset` specifying how to perform the conversion

Method	`__init__`	Undocumented
Method	`load_view`	Loads the `fiftyone.core.view.DatasetView` containing the output of the stage.
Property	`config`	Parameters specifying how to perform the conversion.
Property	`eval_key`	The evaluation key to extract patches for.
Property	`has_view`	Whether this stage's output view should be loaded via `load_view` rather than appending stages to an aggregation pipeline via `to_mongo`.
Class Method	`_params`	Returns a list of JSON dicts describing the stage's supported parameters.
Method	`_kwargs`	Returns a list of `[name, value]` lists describing the parameters of this stage instance.
Instance Variable	`_config`	Undocumented
Instance Variable	`_eval_key`	Undocumented
Instance Variable	`_state`	Undocumented

Inherited from ViewStage:

Method	`__eq__`	Undocumented
Method	`__repr__`	Undocumented
Method	`__str__`	Undocumented
Method	`get_edited_fields`	Returns a list of names of fields or embedded fields that may have been edited by the stage, if any.
Method	`get_excluded_fields`	Returns a list of fields that have been excluded by the stage, if any.
Method	`get_filtered_fields`	Returns a list of names of fields or embedded fields that contain arrays have been filtered by the stage, if any.
Method	`get_group_expr`	Returns the dynamic group expression for the given stage, if any.
Method	`get_media_type`	Returns the media type outputted by this stage when applied to the given collection, if and only if it is different from the input type.
Method	`get_selected_fields`	Returns a list of fields that have been selected by the stage, if any.
Method	`to_mongo`	Returns the MongoDB aggregation pipeline for the stage.
Method	`validate`	Validates that the stage can be applied to the given collection.
Property	`outputs_dynamic_groups`	Whether this stage outputs or flattens dynamic groups.
Class Method	`_from_dict`	Creates a `ViewStage` instance from a serialized JSON dict representation of it.
Method	`_needs_frames`	Whether the stage requires frame labels of video samples to be attached.
Method	`_needs_group_slices`	Whether the stage requires group slice(s) to be attached.
Method	`_serialize`	Returns a JSON dict representation of the `ViewStage`.
Instance Variable	`_uuid`	Undocumented

def __init__(self, eval_key, config=None, _state=None, **kwargs): (source) ¶

Undocumented

def load_view(self, sample_collection): (source) ¶

overrides fiftyone.core.stages.ViewStage.load_view

Loads the fiftyone.core.view.DatasetView containing the output of the stage.

Only usable if has_view is True.

Parameters
sample_collection	the `fiftyone.core.collections.SampleCollection` to which the stage is being applied
Returns
a `fiftyone.core.view.DatasetView`

@property
config = (source) ¶

Parameters specifying how to perform the conversion.

@property
eval_key = (source) ¶

The evaluation key to extract patches for.

@property
has_view = (source) ¶

overrides fiftyone.core.stages.ViewStage.has_view

Whether this stage's output view should be loaded via load_view rather than appending stages to an aggregation pipeline via to_mongo.

@classmethod
def _params(self): (source) ¶

overrides fiftyone.core.stages.ViewStage._params

Returns a list of JSON dicts describing the stage's supported parameters.

Returns
a list of JSON dicts

def _kwargs(self): (source) ¶

overrides fiftyone.core.stages.ViewStage._kwargs

Returns a list of [name, value] lists describing the parameters of this stage instance.

Returns
a list of `[name, value]` lists

_config = (source) ¶

Undocumented

_eval_key = (source) ¶

Undocumented

_state = (source) ¶

Undocumented