class documentation

Base class for evaluation methods.

Parameters
configan BaseEvaluationMethodConfig
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:

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 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 cleanup Cleans up the results of the run with the given key from the collection.
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 get_fields Gets the fields that were involved in the given run.
Method register_run Registers a run of this method under the given key on the given collection.
Method rename Performs any necessary operations required to rename this run's key.
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
Method _validate_run Subclass-specific validation when a run with the given key already exists.

Inherited from Configurable (via EvaluationMethod, BaseRun):

Method __init__ Undocumented
Instance Variable config Undocumented
def cleanup_custom_metrics(self, samples, eval_key): (source)

Undocumented

def compute_custom_metrics(self, samples, eval_key, results): (source)

Undocumented

def get_custom_metric_fields(self, samples, eval_key): (source)

Undocumented

def rename_custom_metrics(self, samples, eval_key, new_eval_key): (source)

Undocumented

def _get_custom_metrics(self): (source)

Undocumented