<!-- # hard line break macro for HTML -->

# fiftyone.utils.eval

* [fiftyone.utils.eval.activitynet](fiftyone.utils.eval.activitynet.md)
  * [`ActivityNetEvaluationConfig`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig)
    * [`ActivityNetEvaluationConfig.method`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.method)
    * [`ActivityNetEvaluationConfig.attributes()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.attributes)
    * [`ActivityNetEvaluationConfig.base_config_cls()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.base_config_cls)
    * [`ActivityNetEvaluationConfig.build()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.build)
    * [`ActivityNetEvaluationConfig.builder()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.builder)
    * [`ActivityNetEvaluationConfig.cls`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.cls)
    * [`ActivityNetEvaluationConfig.copy()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.copy)
    * [`ActivityNetEvaluationConfig.custom_attributes()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.custom_attributes)
    * [`ActivityNetEvaluationConfig.default()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.default)
    * [`ActivityNetEvaluationConfig.from_dict()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.from_dict)
    * [`ActivityNetEvaluationConfig.from_json()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.from_json)
    * [`ActivityNetEvaluationConfig.from_kwargs()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.from_kwargs)
    * [`ActivityNetEvaluationConfig.from_str()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.from_str)
    * [`ActivityNetEvaluationConfig.get_class_name()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.get_class_name)
    * [`ActivityNetEvaluationConfig.load_credentials()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.load_credentials)
    * [`ActivityNetEvaluationConfig.load_default()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.load_default)
    * [`ActivityNetEvaluationConfig.parse_array()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.parse_array)
    * [`ActivityNetEvaluationConfig.parse_bool()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.parse_bool)
    * [`ActivityNetEvaluationConfig.parse_categorical()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.parse_categorical)
    * [`ActivityNetEvaluationConfig.parse_dict()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.parse_dict)
    * [`ActivityNetEvaluationConfig.parse_int()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.parse_int)
    * [`ActivityNetEvaluationConfig.parse_mutually_exclusive_fields()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.parse_mutually_exclusive_fields)
    * [`ActivityNetEvaluationConfig.parse_number()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.parse_number)
    * [`ActivityNetEvaluationConfig.parse_object()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.parse_object)
    * [`ActivityNetEvaluationConfig.parse_object_array()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.parse_object_array)
    * [`ActivityNetEvaluationConfig.parse_object_dict()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.parse_object_dict)
    * [`ActivityNetEvaluationConfig.parse_path()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.parse_path)
    * [`ActivityNetEvaluationConfig.parse_raw()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.parse_raw)
    * [`ActivityNetEvaluationConfig.parse_string()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.parse_string)
    * [`ActivityNetEvaluationConfig.requires_additional_fields`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.requires_additional_fields)
    * [`ActivityNetEvaluationConfig.run_cls`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.run_cls)
    * [`ActivityNetEvaluationConfig.serialize()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.serialize)
    * [`ActivityNetEvaluationConfig.to_str()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.to_str)
    * [`ActivityNetEvaluationConfig.type`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.type)
    * [`ActivityNetEvaluationConfig.validate_all_or_nothing_fields()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.validate_all_or_nothing_fields)
    * [`ActivityNetEvaluationConfig.write_json()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.write_json)
  * [`ActivityNetEvaluation`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation)
    * [`ActivityNetEvaluation.evaluate()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.evaluate)
    * [`ActivityNetEvaluation.generate_results()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.generate_results)
    * [`ActivityNetEvaluation.add_fields_to_sidebar_group()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.add_fields_to_sidebar_group)
    * [`ActivityNetEvaluation.cleanup()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.cleanup)
    * [`ActivityNetEvaluation.cleanup_custom_metrics()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.cleanup_custom_metrics)
    * [`ActivityNetEvaluation.compute_custom_metrics()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.compute_custom_metrics)
    * [`ActivityNetEvaluation.delete_run()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.delete_run)
    * [`ActivityNetEvaluation.delete_runs()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.delete_runs)
    * [`ActivityNetEvaluation.ensure_requirements()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.ensure_requirements)
    * [`ActivityNetEvaluation.ensure_usage_requirements()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.ensure_usage_requirements)
    * [`ActivityNetEvaluation.from_config()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.from_config)
    * [`ActivityNetEvaluation.from_dict()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.from_dict)
    * [`ActivityNetEvaluation.from_json()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.from_json)
    * [`ActivityNetEvaluation.from_kwargs()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.from_kwargs)
    * [`ActivityNetEvaluation.get_custom_metric_fields()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.get_custom_metric_fields)
    * [`ActivityNetEvaluation.get_fields()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.get_fields)
    * [`ActivityNetEvaluation.get_run_info()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.get_run_info)
    * [`ActivityNetEvaluation.has_cached_run_results()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.has_cached_run_results)
    * [`ActivityNetEvaluation.list_runs()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.list_runs)
    * [`ActivityNetEvaluation.load_run_results()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.load_run_results)
    * [`ActivityNetEvaluation.load_run_view()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.load_run_view)
    * [`ActivityNetEvaluation.parse()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.parse)
    * [`ActivityNetEvaluation.register_run()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.register_run)
    * [`ActivityNetEvaluation.register_samples()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.register_samples)
    * [`ActivityNetEvaluation.rename()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.rename)
    * [`ActivityNetEvaluation.rename_custom_metrics()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.rename_custom_metrics)
    * [`ActivityNetEvaluation.run_info_cls()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.run_info_cls)
    * [`ActivityNetEvaluation.save_run_info()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.save_run_info)
    * [`ActivityNetEvaluation.save_run_results()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.save_run_results)
    * [`ActivityNetEvaluation.update_run_config()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.update_run_config)
    * [`ActivityNetEvaluation.update_run_key()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.update_run_key)
    * [`ActivityNetEvaluation.validate()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.validate)
    * [`ActivityNetEvaluation.validate_run()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluation.validate_run)
  * [`ActivityNetDetectionResults`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults)
    * [`ActivityNetDetectionResults.plot_pr_curves()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.plot_pr_curves)
    * [`ActivityNetDetectionResults.mAP()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.mAP)
    * [`ActivityNetDetectionResults.add_custom_metrics()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.add_custom_metrics)
    * [`ActivityNetDetectionResults.attributes()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.attributes)
    * [`ActivityNetDetectionResults.backend`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.backend)
    * [`ActivityNetDetectionResults.base_results_cls()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.base_results_cls)
    * [`ActivityNetDetectionResults.clear_subset()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.clear_subset)
    * [`ActivityNetDetectionResults.cls`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.cls)
    * [`ActivityNetDetectionResults.config`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.config)
    * [`ActivityNetDetectionResults.confusion_matrix()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.confusion_matrix)
    * [`ActivityNetDetectionResults.copy()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.copy)
    * [`ActivityNetDetectionResults.custom_attributes()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.custom_attributes)
    * [`ActivityNetDetectionResults.from_dict()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.from_dict)
    * [`ActivityNetDetectionResults.from_json()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.from_json)
    * [`ActivityNetDetectionResults.from_str()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.from_str)
    * [`ActivityNetDetectionResults.get_class_name()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.get_class_name)
    * [`ActivityNetDetectionResults.get_meta()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.get_meta)
    * [`ActivityNetDetectionResults.has_subset`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.has_subset)
    * [`ActivityNetDetectionResults.key`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.key)
    * [`ActivityNetDetectionResults.metrics()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.metrics)
    * [`ActivityNetDetectionResults.plot_confusion_matrix()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.plot_confusion_matrix)
    * [`ActivityNetDetectionResults.print_metrics()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.print_metrics)
    * [`ActivityNetDetectionResults.print_report()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.print_report)
    * [`ActivityNetDetectionResults.report()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.report)
    * [`ActivityNetDetectionResults.samples`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.samples)
    * [`ActivityNetDetectionResults.save()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.save)
    * [`ActivityNetDetectionResults.save_config()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.save_config)
    * [`ActivityNetDetectionResults.serialize()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.serialize)
    * [`ActivityNetDetectionResults.to_str()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.to_str)
    * [`ActivityNetDetectionResults.use_subset()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.use_subset)
    * [`ActivityNetDetectionResults.write_json()`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.write_json)
* [fiftyone.utils.eval.base](fiftyone.utils.eval.base.md)
  * [`get_subset_view()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.get_subset_view)
  * [`BaseEvaluationMethodConfig`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig)
    * [`BaseEvaluationMethodConfig.attributes()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.attributes)
    * [`BaseEvaluationMethodConfig.base_config_cls()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.base_config_cls)
    * [`BaseEvaluationMethodConfig.build()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.build)
    * [`BaseEvaluationMethodConfig.builder()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.builder)
    * [`BaseEvaluationMethodConfig.cls`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.cls)
    * [`BaseEvaluationMethodConfig.copy()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.copy)
    * [`BaseEvaluationMethodConfig.custom_attributes()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.custom_attributes)
    * [`BaseEvaluationMethodConfig.default()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.default)
    * [`BaseEvaluationMethodConfig.from_dict()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.from_dict)
    * [`BaseEvaluationMethodConfig.from_json()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.from_json)
    * [`BaseEvaluationMethodConfig.from_kwargs()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.from_kwargs)
    * [`BaseEvaluationMethodConfig.from_str()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.from_str)
    * [`BaseEvaluationMethodConfig.get_class_name()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.get_class_name)
    * [`BaseEvaluationMethodConfig.load_credentials()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.load_credentials)
    * [`BaseEvaluationMethodConfig.load_default()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.load_default)
    * [`BaseEvaluationMethodConfig.method`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.method)
    * [`BaseEvaluationMethodConfig.parse_array()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_array)
    * [`BaseEvaluationMethodConfig.parse_bool()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_bool)
    * [`BaseEvaluationMethodConfig.parse_categorical()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_categorical)
    * [`BaseEvaluationMethodConfig.parse_dict()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_dict)
    * [`BaseEvaluationMethodConfig.parse_int()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_int)
    * [`BaseEvaluationMethodConfig.parse_mutually_exclusive_fields()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_mutually_exclusive_fields)
    * [`BaseEvaluationMethodConfig.parse_number()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_number)
    * [`BaseEvaluationMethodConfig.parse_object()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_object)
    * [`BaseEvaluationMethodConfig.parse_object_array()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_object_array)
    * [`BaseEvaluationMethodConfig.parse_object_dict()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_object_dict)
    * [`BaseEvaluationMethodConfig.parse_path()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_path)
    * [`BaseEvaluationMethodConfig.parse_raw()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_raw)
    * [`BaseEvaluationMethodConfig.parse_string()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.parse_string)
    * [`BaseEvaluationMethodConfig.run_cls`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.run_cls)
    * [`BaseEvaluationMethodConfig.serialize()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.serialize)
    * [`BaseEvaluationMethodConfig.to_str()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.to_str)
    * [`BaseEvaluationMethodConfig.type`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.type)
    * [`BaseEvaluationMethodConfig.validate_all_or_nothing_fields()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.validate_all_or_nothing_fields)
    * [`BaseEvaluationMethodConfig.write_json()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig.write_json)
  * [`BaseEvaluationMethod`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod)
    * [`BaseEvaluationMethod.compute_custom_metrics()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.compute_custom_metrics)
    * [`BaseEvaluationMethod.get_custom_metric_fields()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.get_custom_metric_fields)
    * [`BaseEvaluationMethod.rename_custom_metrics()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.rename_custom_metrics)
    * [`BaseEvaluationMethod.cleanup_custom_metrics()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.cleanup_custom_metrics)
    * [`BaseEvaluationMethod.get_fields()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.get_fields)
    * [`BaseEvaluationMethod.add_fields_to_sidebar_group()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.add_fields_to_sidebar_group)
    * [`BaseEvaluationMethod.cleanup()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.cleanup)
    * [`BaseEvaluationMethod.delete_run()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.delete_run)
    * [`BaseEvaluationMethod.delete_runs()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.delete_runs)
    * [`BaseEvaluationMethod.ensure_requirements()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.ensure_requirements)
    * [`BaseEvaluationMethod.ensure_usage_requirements()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.ensure_usage_requirements)
    * [`BaseEvaluationMethod.from_config()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.from_config)
    * [`BaseEvaluationMethod.from_dict()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.from_dict)
    * [`BaseEvaluationMethod.from_json()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.from_json)
    * [`BaseEvaluationMethod.from_kwargs()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.from_kwargs)
    * [`BaseEvaluationMethod.get_run_info()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.get_run_info)
    * [`BaseEvaluationMethod.has_cached_run_results()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.has_cached_run_results)
    * [`BaseEvaluationMethod.list_runs()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.list_runs)
    * [`BaseEvaluationMethod.load_run_results()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.load_run_results)
    * [`BaseEvaluationMethod.load_run_view()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.load_run_view)
    * [`BaseEvaluationMethod.parse()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.parse)
    * [`BaseEvaluationMethod.register_run()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.register_run)
    * [`BaseEvaluationMethod.rename()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.rename)
    * [`BaseEvaluationMethod.run_info_cls()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.run_info_cls)
    * [`BaseEvaluationMethod.save_run_info()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.save_run_info)
    * [`BaseEvaluationMethod.save_run_results()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.save_run_results)
    * [`BaseEvaluationMethod.update_run_config()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.update_run_config)
    * [`BaseEvaluationMethod.update_run_key()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.update_run_key)
    * [`BaseEvaluationMethod.validate()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.validate)
    * [`BaseEvaluationMethod.validate_run()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethod.validate_run)
  * [`BaseEvaluationResults`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults)
    * [`BaseEvaluationResults.add_custom_metrics()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.add_custom_metrics)
    * [`BaseEvaluationResults.metrics()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.metrics)
    * [`BaseEvaluationResults.print_metrics()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.print_metrics)
    * [`BaseEvaluationResults.attributes()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.attributes)
    * [`BaseEvaluationResults.backend`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.backend)
    * [`BaseEvaluationResults.base_results_cls()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.base_results_cls)
    * [`BaseEvaluationResults.cls`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.cls)
    * [`BaseEvaluationResults.config`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.config)
    * [`BaseEvaluationResults.copy()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.copy)
    * [`BaseEvaluationResults.custom_attributes()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.custom_attributes)
    * [`BaseEvaluationResults.from_dict()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.from_dict)
    * [`BaseEvaluationResults.from_json()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.from_json)
    * [`BaseEvaluationResults.from_str()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.from_str)
    * [`BaseEvaluationResults.get_class_name()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.get_class_name)
    * [`BaseEvaluationResults.get_meta()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.get_meta)
    * [`BaseEvaluationResults.key`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.key)
    * [`BaseEvaluationResults.samples`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.samples)
    * [`BaseEvaluationResults.save()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.save)
    * [`BaseEvaluationResults.save_config()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.save_config)
    * [`BaseEvaluationResults.serialize()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.serialize)
    * [`BaseEvaluationResults.to_str()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.to_str)
    * [`BaseEvaluationResults.write_json()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults.write_json)
  * [`BaseClassificationResults`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults)
    * [`BaseClassificationResults.has_subset`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.has_subset)
    * [`BaseClassificationResults.use_subset()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.use_subset)
    * [`BaseClassificationResults.clear_subset()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.clear_subset)
    * [`BaseClassificationResults.report()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.report)
    * [`BaseClassificationResults.print_report()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.print_report)
    * [`BaseClassificationResults.metrics()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.metrics)
    * [`BaseClassificationResults.print_metrics()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.print_metrics)
    * [`BaseClassificationResults.confusion_matrix()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.confusion_matrix)
    * [`BaseClassificationResults.plot_confusion_matrix()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.plot_confusion_matrix)
    * [`BaseClassificationResults.add_custom_metrics()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.add_custom_metrics)
    * [`BaseClassificationResults.attributes()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.attributes)
    * [`BaseClassificationResults.backend`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.backend)
    * [`BaseClassificationResults.base_results_cls()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.base_results_cls)
    * [`BaseClassificationResults.cls`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.cls)
    * [`BaseClassificationResults.config`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.config)
    * [`BaseClassificationResults.copy()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.copy)
    * [`BaseClassificationResults.custom_attributes()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.custom_attributes)
    * [`BaseClassificationResults.from_dict()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.from_dict)
    * [`BaseClassificationResults.from_json()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.from_json)
    * [`BaseClassificationResults.from_str()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.from_str)
    * [`BaseClassificationResults.get_class_name()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.get_class_name)
    * [`BaseClassificationResults.get_meta()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.get_meta)
    * [`BaseClassificationResults.key`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.key)
    * [`BaseClassificationResults.samples`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.samples)
    * [`BaseClassificationResults.save()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.save)
    * [`BaseClassificationResults.save_config()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.save_config)
    * [`BaseClassificationResults.serialize()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.serialize)
    * [`BaseClassificationResults.to_str()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.to_str)
    * [`BaseClassificationResults.write_json()`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults.write_json)
* [fiftyone.utils.eval.classification](fiftyone.utils.eval.classification.md)
  * [`evaluate_classifications()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.evaluate_classifications)
  * [`ClassificationEvaluationConfig`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig)
    * [`ClassificationEvaluationConfig.type`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.type)
    * [`ClassificationEvaluationConfig.attributes()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.attributes)
    * [`ClassificationEvaluationConfig.base_config_cls()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.base_config_cls)
    * [`ClassificationEvaluationConfig.build()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.build)
    * [`ClassificationEvaluationConfig.builder()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.builder)
    * [`ClassificationEvaluationConfig.cls`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.cls)
    * [`ClassificationEvaluationConfig.copy()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.copy)
    * [`ClassificationEvaluationConfig.custom_attributes()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.custom_attributes)
    * [`ClassificationEvaluationConfig.default()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.default)
    * [`ClassificationEvaluationConfig.from_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.from_dict)
    * [`ClassificationEvaluationConfig.from_json()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.from_json)
    * [`ClassificationEvaluationConfig.from_kwargs()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.from_kwargs)
    * [`ClassificationEvaluationConfig.from_str()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.from_str)
    * [`ClassificationEvaluationConfig.get_class_name()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.get_class_name)
    * [`ClassificationEvaluationConfig.load_credentials()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.load_credentials)
    * [`ClassificationEvaluationConfig.load_default()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.load_default)
    * [`ClassificationEvaluationConfig.method`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.method)
    * [`ClassificationEvaluationConfig.parse_array()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.parse_array)
    * [`ClassificationEvaluationConfig.parse_bool()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.parse_bool)
    * [`ClassificationEvaluationConfig.parse_categorical()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.parse_categorical)
    * [`ClassificationEvaluationConfig.parse_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.parse_dict)
    * [`ClassificationEvaluationConfig.parse_int()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.parse_int)
    * [`ClassificationEvaluationConfig.parse_mutually_exclusive_fields()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.parse_mutually_exclusive_fields)
    * [`ClassificationEvaluationConfig.parse_number()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.parse_number)
    * [`ClassificationEvaluationConfig.parse_object()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.parse_object)
    * [`ClassificationEvaluationConfig.parse_object_array()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.parse_object_array)
    * [`ClassificationEvaluationConfig.parse_object_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.parse_object_dict)
    * [`ClassificationEvaluationConfig.parse_path()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.parse_path)
    * [`ClassificationEvaluationConfig.parse_raw()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.parse_raw)
    * [`ClassificationEvaluationConfig.parse_string()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.parse_string)
    * [`ClassificationEvaluationConfig.run_cls`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.run_cls)
    * [`ClassificationEvaluationConfig.serialize()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.serialize)
    * [`ClassificationEvaluationConfig.to_str()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.to_str)
    * [`ClassificationEvaluationConfig.validate_all_or_nothing_fields()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.validate_all_or_nothing_fields)
    * [`ClassificationEvaluationConfig.write_json()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluationConfig.write_json)
  * [`ClassificationEvaluation`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation)
    * [`ClassificationEvaluation.register_samples()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.register_samples)
    * [`ClassificationEvaluation.evaluate_samples()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.evaluate_samples)
    * [`ClassificationEvaluation.get_fields()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.get_fields)
    * [`ClassificationEvaluation.rename()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.rename)
    * [`ClassificationEvaluation.cleanup()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.cleanup)
    * [`ClassificationEvaluation.add_fields_to_sidebar_group()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.add_fields_to_sidebar_group)
    * [`ClassificationEvaluation.cleanup_custom_metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.cleanup_custom_metrics)
    * [`ClassificationEvaluation.compute_custom_metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.compute_custom_metrics)
    * [`ClassificationEvaluation.delete_run()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.delete_run)
    * [`ClassificationEvaluation.delete_runs()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.delete_runs)
    * [`ClassificationEvaluation.ensure_requirements()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.ensure_requirements)
    * [`ClassificationEvaluation.ensure_usage_requirements()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.ensure_usage_requirements)
    * [`ClassificationEvaluation.from_config()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.from_config)
    * [`ClassificationEvaluation.from_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.from_dict)
    * [`ClassificationEvaluation.from_json()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.from_json)
    * [`ClassificationEvaluation.from_kwargs()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.from_kwargs)
    * [`ClassificationEvaluation.get_custom_metric_fields()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.get_custom_metric_fields)
    * [`ClassificationEvaluation.get_run_info()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.get_run_info)
    * [`ClassificationEvaluation.has_cached_run_results()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.has_cached_run_results)
    * [`ClassificationEvaluation.list_runs()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.list_runs)
    * [`ClassificationEvaluation.load_run_results()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.load_run_results)
    * [`ClassificationEvaluation.load_run_view()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.load_run_view)
    * [`ClassificationEvaluation.parse()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.parse)
    * [`ClassificationEvaluation.register_run()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.register_run)
    * [`ClassificationEvaluation.rename_custom_metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.rename_custom_metrics)
    * [`ClassificationEvaluation.run_info_cls()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.run_info_cls)
    * [`ClassificationEvaluation.save_run_info()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.save_run_info)
    * [`ClassificationEvaluation.save_run_results()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.save_run_results)
    * [`ClassificationEvaluation.update_run_config()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.update_run_config)
    * [`ClassificationEvaluation.update_run_key()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.update_run_key)
    * [`ClassificationEvaluation.validate()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.validate)
    * [`ClassificationEvaluation.validate_run()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationEvaluation.validate_run)
  * [`SimpleEvaluationConfig`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig)
    * [`SimpleEvaluationConfig.method`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.method)
    * [`SimpleEvaluationConfig.attributes()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.attributes)
    * [`SimpleEvaluationConfig.base_config_cls()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.base_config_cls)
    * [`SimpleEvaluationConfig.build()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.build)
    * [`SimpleEvaluationConfig.builder()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.builder)
    * [`SimpleEvaluationConfig.cls`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.cls)
    * [`SimpleEvaluationConfig.copy()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.copy)
    * [`SimpleEvaluationConfig.custom_attributes()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.custom_attributes)
    * [`SimpleEvaluationConfig.default()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.default)
    * [`SimpleEvaluationConfig.from_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.from_dict)
    * [`SimpleEvaluationConfig.from_json()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.from_json)
    * [`SimpleEvaluationConfig.from_kwargs()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.from_kwargs)
    * [`SimpleEvaluationConfig.from_str()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.from_str)
    * [`SimpleEvaluationConfig.get_class_name()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.get_class_name)
    * [`SimpleEvaluationConfig.load_credentials()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.load_credentials)
    * [`SimpleEvaluationConfig.load_default()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.load_default)
    * [`SimpleEvaluationConfig.parse_array()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.parse_array)
    * [`SimpleEvaluationConfig.parse_bool()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.parse_bool)
    * [`SimpleEvaluationConfig.parse_categorical()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.parse_categorical)
    * [`SimpleEvaluationConfig.parse_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.parse_dict)
    * [`SimpleEvaluationConfig.parse_int()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.parse_int)
    * [`SimpleEvaluationConfig.parse_mutually_exclusive_fields()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.parse_mutually_exclusive_fields)
    * [`SimpleEvaluationConfig.parse_number()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.parse_number)
    * [`SimpleEvaluationConfig.parse_object()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.parse_object)
    * [`SimpleEvaluationConfig.parse_object_array()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.parse_object_array)
    * [`SimpleEvaluationConfig.parse_object_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.parse_object_dict)
    * [`SimpleEvaluationConfig.parse_path()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.parse_path)
    * [`SimpleEvaluationConfig.parse_raw()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.parse_raw)
    * [`SimpleEvaluationConfig.parse_string()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.parse_string)
    * [`SimpleEvaluationConfig.run_cls`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.run_cls)
    * [`SimpleEvaluationConfig.serialize()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.serialize)
    * [`SimpleEvaluationConfig.to_str()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.to_str)
    * [`SimpleEvaluationConfig.type`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.type)
    * [`SimpleEvaluationConfig.validate_all_or_nothing_fields()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.validate_all_or_nothing_fields)
    * [`SimpleEvaluationConfig.write_json()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluationConfig.write_json)
  * [`SimpleEvaluation`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation)
    * [`SimpleEvaluation.register_samples()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.register_samples)
    * [`SimpleEvaluation.evaluate_samples()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.evaluate_samples)
    * [`SimpleEvaluation.add_fields_to_sidebar_group()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.add_fields_to_sidebar_group)
    * [`SimpleEvaluation.cleanup()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.cleanup)
    * [`SimpleEvaluation.cleanup_custom_metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.cleanup_custom_metrics)
    * [`SimpleEvaluation.compute_custom_metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.compute_custom_metrics)
    * [`SimpleEvaluation.delete_run()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.delete_run)
    * [`SimpleEvaluation.delete_runs()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.delete_runs)
    * [`SimpleEvaluation.ensure_requirements()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.ensure_requirements)
    * [`SimpleEvaluation.ensure_usage_requirements()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.ensure_usage_requirements)
    * [`SimpleEvaluation.from_config()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.from_config)
    * [`SimpleEvaluation.from_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.from_dict)
    * [`SimpleEvaluation.from_json()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.from_json)
    * [`SimpleEvaluation.from_kwargs()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.from_kwargs)
    * [`SimpleEvaluation.get_custom_metric_fields()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.get_custom_metric_fields)
    * [`SimpleEvaluation.get_fields()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.get_fields)
    * [`SimpleEvaluation.get_run_info()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.get_run_info)
    * [`SimpleEvaluation.has_cached_run_results()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.has_cached_run_results)
    * [`SimpleEvaluation.list_runs()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.list_runs)
    * [`SimpleEvaluation.load_run_results()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.load_run_results)
    * [`SimpleEvaluation.load_run_view()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.load_run_view)
    * [`SimpleEvaluation.parse()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.parse)
    * [`SimpleEvaluation.register_run()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.register_run)
    * [`SimpleEvaluation.rename()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.rename)
    * [`SimpleEvaluation.rename_custom_metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.rename_custom_metrics)
    * [`SimpleEvaluation.run_info_cls()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.run_info_cls)
    * [`SimpleEvaluation.save_run_info()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.save_run_info)
    * [`SimpleEvaluation.save_run_results()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.save_run_results)
    * [`SimpleEvaluation.update_run_config()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.update_run_config)
    * [`SimpleEvaluation.update_run_key()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.update_run_key)
    * [`SimpleEvaluation.validate()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.validate)
    * [`SimpleEvaluation.validate_run()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.SimpleEvaluation.validate_run)
  * [`TopKEvaluationConfig`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig)
    * [`TopKEvaluationConfig.method`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.method)
    * [`TopKEvaluationConfig.attributes()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.attributes)
    * [`TopKEvaluationConfig.base_config_cls()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.base_config_cls)
    * [`TopKEvaluationConfig.build()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.build)
    * [`TopKEvaluationConfig.builder()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.builder)
    * [`TopKEvaluationConfig.cls`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.cls)
    * [`TopKEvaluationConfig.copy()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.copy)
    * [`TopKEvaluationConfig.custom_attributes()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.custom_attributes)
    * [`TopKEvaluationConfig.default()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.default)
    * [`TopKEvaluationConfig.from_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.from_dict)
    * [`TopKEvaluationConfig.from_json()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.from_json)
    * [`TopKEvaluationConfig.from_kwargs()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.from_kwargs)
    * [`TopKEvaluationConfig.from_str()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.from_str)
    * [`TopKEvaluationConfig.get_class_name()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.get_class_name)
    * [`TopKEvaluationConfig.load_credentials()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.load_credentials)
    * [`TopKEvaluationConfig.load_default()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.load_default)
    * [`TopKEvaluationConfig.parse_array()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.parse_array)
    * [`TopKEvaluationConfig.parse_bool()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.parse_bool)
    * [`TopKEvaluationConfig.parse_categorical()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.parse_categorical)
    * [`TopKEvaluationConfig.parse_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.parse_dict)
    * [`TopKEvaluationConfig.parse_int()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.parse_int)
    * [`TopKEvaluationConfig.parse_mutually_exclusive_fields()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.parse_mutually_exclusive_fields)
    * [`TopKEvaluationConfig.parse_number()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.parse_number)
    * [`TopKEvaluationConfig.parse_object()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.parse_object)
    * [`TopKEvaluationConfig.parse_object_array()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.parse_object_array)
    * [`TopKEvaluationConfig.parse_object_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.parse_object_dict)
    * [`TopKEvaluationConfig.parse_path()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.parse_path)
    * [`TopKEvaluationConfig.parse_raw()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.parse_raw)
    * [`TopKEvaluationConfig.parse_string()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.parse_string)
    * [`TopKEvaluationConfig.run_cls`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.run_cls)
    * [`TopKEvaluationConfig.serialize()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.serialize)
    * [`TopKEvaluationConfig.to_str()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.to_str)
    * [`TopKEvaluationConfig.type`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.type)
    * [`TopKEvaluationConfig.validate_all_or_nothing_fields()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.validate_all_or_nothing_fields)
    * [`TopKEvaluationConfig.write_json()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluationConfig.write_json)
  * [`TopKEvaluation`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation)
    * [`TopKEvaluation.register_samples()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.register_samples)
    * [`TopKEvaluation.evaluate_samples()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.evaluate_samples)
    * [`TopKEvaluation.add_fields_to_sidebar_group()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.add_fields_to_sidebar_group)
    * [`TopKEvaluation.cleanup()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.cleanup)
    * [`TopKEvaluation.cleanup_custom_metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.cleanup_custom_metrics)
    * [`TopKEvaluation.compute_custom_metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.compute_custom_metrics)
    * [`TopKEvaluation.delete_run()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.delete_run)
    * [`TopKEvaluation.delete_runs()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.delete_runs)
    * [`TopKEvaluation.ensure_requirements()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.ensure_requirements)
    * [`TopKEvaluation.ensure_usage_requirements()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.ensure_usage_requirements)
    * [`TopKEvaluation.from_config()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.from_config)
    * [`TopKEvaluation.from_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.from_dict)
    * [`TopKEvaluation.from_json()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.from_json)
    * [`TopKEvaluation.from_kwargs()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.from_kwargs)
    * [`TopKEvaluation.get_custom_metric_fields()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.get_custom_metric_fields)
    * [`TopKEvaluation.get_fields()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.get_fields)
    * [`TopKEvaluation.get_run_info()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.get_run_info)
    * [`TopKEvaluation.has_cached_run_results()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.has_cached_run_results)
    * [`TopKEvaluation.list_runs()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.list_runs)
    * [`TopKEvaluation.load_run_results()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.load_run_results)
    * [`TopKEvaluation.load_run_view()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.load_run_view)
    * [`TopKEvaluation.parse()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.parse)
    * [`TopKEvaluation.register_run()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.register_run)
    * [`TopKEvaluation.rename()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.rename)
    * [`TopKEvaluation.rename_custom_metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.rename_custom_metrics)
    * [`TopKEvaluation.run_info_cls()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.run_info_cls)
    * [`TopKEvaluation.save_run_info()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.save_run_info)
    * [`TopKEvaluation.save_run_results()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.save_run_results)
    * [`TopKEvaluation.update_run_config()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.update_run_config)
    * [`TopKEvaluation.update_run_key()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.update_run_key)
    * [`TopKEvaluation.validate()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.validate)
    * [`TopKEvaluation.validate_run()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.TopKEvaluation.validate_run)
  * [`BinaryEvaluationConfig`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig)
    * [`BinaryEvaluationConfig.method`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.method)
    * [`BinaryEvaluationConfig.attributes()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.attributes)
    * [`BinaryEvaluationConfig.base_config_cls()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.base_config_cls)
    * [`BinaryEvaluationConfig.build()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.build)
    * [`BinaryEvaluationConfig.builder()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.builder)
    * [`BinaryEvaluationConfig.cls`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.cls)
    * [`BinaryEvaluationConfig.copy()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.copy)
    * [`BinaryEvaluationConfig.custom_attributes()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.custom_attributes)
    * [`BinaryEvaluationConfig.default()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.default)
    * [`BinaryEvaluationConfig.from_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.from_dict)
    * [`BinaryEvaluationConfig.from_json()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.from_json)
    * [`BinaryEvaluationConfig.from_kwargs()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.from_kwargs)
    * [`BinaryEvaluationConfig.from_str()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.from_str)
    * [`BinaryEvaluationConfig.get_class_name()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.get_class_name)
    * [`BinaryEvaluationConfig.load_credentials()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.load_credentials)
    * [`BinaryEvaluationConfig.load_default()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.load_default)
    * [`BinaryEvaluationConfig.parse_array()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.parse_array)
    * [`BinaryEvaluationConfig.parse_bool()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.parse_bool)
    * [`BinaryEvaluationConfig.parse_categorical()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.parse_categorical)
    * [`BinaryEvaluationConfig.parse_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.parse_dict)
    * [`BinaryEvaluationConfig.parse_int()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.parse_int)
    * [`BinaryEvaluationConfig.parse_mutually_exclusive_fields()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.parse_mutually_exclusive_fields)
    * [`BinaryEvaluationConfig.parse_number()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.parse_number)
    * [`BinaryEvaluationConfig.parse_object()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.parse_object)
    * [`BinaryEvaluationConfig.parse_object_array()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.parse_object_array)
    * [`BinaryEvaluationConfig.parse_object_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.parse_object_dict)
    * [`BinaryEvaluationConfig.parse_path()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.parse_path)
    * [`BinaryEvaluationConfig.parse_raw()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.parse_raw)
    * [`BinaryEvaluationConfig.parse_string()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.parse_string)
    * [`BinaryEvaluationConfig.run_cls`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.run_cls)
    * [`BinaryEvaluationConfig.serialize()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.serialize)
    * [`BinaryEvaluationConfig.to_str()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.to_str)
    * [`BinaryEvaluationConfig.type`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.type)
    * [`BinaryEvaluationConfig.validate_all_or_nothing_fields()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.validate_all_or_nothing_fields)
    * [`BinaryEvaluationConfig.write_json()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluationConfig.write_json)
  * [`BinaryEvaluation`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation)
    * [`BinaryEvaluation.register_samples()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.register_samples)
    * [`BinaryEvaluation.evaluate_samples()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.evaluate_samples)
    * [`BinaryEvaluation.add_fields_to_sidebar_group()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.add_fields_to_sidebar_group)
    * [`BinaryEvaluation.cleanup()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.cleanup)
    * [`BinaryEvaluation.cleanup_custom_metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.cleanup_custom_metrics)
    * [`BinaryEvaluation.compute_custom_metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.compute_custom_metrics)
    * [`BinaryEvaluation.delete_run()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.delete_run)
    * [`BinaryEvaluation.delete_runs()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.delete_runs)
    * [`BinaryEvaluation.ensure_requirements()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.ensure_requirements)
    * [`BinaryEvaluation.ensure_usage_requirements()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.ensure_usage_requirements)
    * [`BinaryEvaluation.from_config()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.from_config)
    * [`BinaryEvaluation.from_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.from_dict)
    * [`BinaryEvaluation.from_json()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.from_json)
    * [`BinaryEvaluation.from_kwargs()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.from_kwargs)
    * [`BinaryEvaluation.get_custom_metric_fields()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.get_custom_metric_fields)
    * [`BinaryEvaluation.get_fields()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.get_fields)
    * [`BinaryEvaluation.get_run_info()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.get_run_info)
    * [`BinaryEvaluation.has_cached_run_results()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.has_cached_run_results)
    * [`BinaryEvaluation.list_runs()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.list_runs)
    * [`BinaryEvaluation.load_run_results()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.load_run_results)
    * [`BinaryEvaluation.load_run_view()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.load_run_view)
    * [`BinaryEvaluation.parse()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.parse)
    * [`BinaryEvaluation.register_run()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.register_run)
    * [`BinaryEvaluation.rename()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.rename)
    * [`BinaryEvaluation.rename_custom_metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.rename_custom_metrics)
    * [`BinaryEvaluation.run_info_cls()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.run_info_cls)
    * [`BinaryEvaluation.save_run_info()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.save_run_info)
    * [`BinaryEvaluation.save_run_results()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.save_run_results)
    * [`BinaryEvaluation.update_run_config()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.update_run_config)
    * [`BinaryEvaluation.update_run_key()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.update_run_key)
    * [`BinaryEvaluation.validate()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.validate)
    * [`BinaryEvaluation.validate_run()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryEvaluation.validate_run)
  * [`ClassificationResults`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults)
    * [`ClassificationResults.add_custom_metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.add_custom_metrics)
    * [`ClassificationResults.attributes()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.attributes)
    * [`ClassificationResults.backend`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.backend)
    * [`ClassificationResults.base_results_cls()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.base_results_cls)
    * [`ClassificationResults.clear_subset()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.clear_subset)
    * [`ClassificationResults.cls`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.cls)
    * [`ClassificationResults.config`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.config)
    * [`ClassificationResults.confusion_matrix()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.confusion_matrix)
    * [`ClassificationResults.copy()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.copy)
    * [`ClassificationResults.custom_attributes()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.custom_attributes)
    * [`ClassificationResults.from_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.from_dict)
    * [`ClassificationResults.from_json()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.from_json)
    * [`ClassificationResults.from_str()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.from_str)
    * [`ClassificationResults.get_class_name()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.get_class_name)
    * [`ClassificationResults.get_meta()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.get_meta)
    * [`ClassificationResults.has_subset`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.has_subset)
    * [`ClassificationResults.key`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.key)
    * [`ClassificationResults.metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.metrics)
    * [`ClassificationResults.plot_confusion_matrix()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.plot_confusion_matrix)
    * [`ClassificationResults.print_metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.print_metrics)
    * [`ClassificationResults.print_report()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.print_report)
    * [`ClassificationResults.report()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.report)
    * [`ClassificationResults.samples`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.samples)
    * [`ClassificationResults.save()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.save)
    * [`ClassificationResults.save_config()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.save_config)
    * [`ClassificationResults.serialize()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.serialize)
    * [`ClassificationResults.to_str()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.to_str)
    * [`ClassificationResults.use_subset()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.use_subset)
    * [`ClassificationResults.write_json()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.ClassificationResults.write_json)
  * [`BinaryClassificationResults`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults)
    * [`BinaryClassificationResults.average_precision()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.average_precision)
    * [`BinaryClassificationResults.plot_pr_curve()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.plot_pr_curve)
    * [`BinaryClassificationResults.plot_roc_curve()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.plot_roc_curve)
    * [`BinaryClassificationResults.metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.metrics)
    * [`BinaryClassificationResults.add_custom_metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.add_custom_metrics)
    * [`BinaryClassificationResults.attributes()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.attributes)
    * [`BinaryClassificationResults.backend`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.backend)
    * [`BinaryClassificationResults.base_results_cls()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.base_results_cls)
    * [`BinaryClassificationResults.clear_subset()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.clear_subset)
    * [`BinaryClassificationResults.cls`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.cls)
    * [`BinaryClassificationResults.config`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.config)
    * [`BinaryClassificationResults.confusion_matrix()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.confusion_matrix)
    * [`BinaryClassificationResults.copy()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.copy)
    * [`BinaryClassificationResults.custom_attributes()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.custom_attributes)
    * [`BinaryClassificationResults.from_dict()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.from_dict)
    * [`BinaryClassificationResults.from_json()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.from_json)
    * [`BinaryClassificationResults.from_str()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.from_str)
    * [`BinaryClassificationResults.get_class_name()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.get_class_name)
    * [`BinaryClassificationResults.get_meta()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.get_meta)
    * [`BinaryClassificationResults.has_subset`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.has_subset)
    * [`BinaryClassificationResults.key`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.key)
    * [`BinaryClassificationResults.plot_confusion_matrix()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.plot_confusion_matrix)
    * [`BinaryClassificationResults.print_metrics()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.print_metrics)
    * [`BinaryClassificationResults.print_report()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.print_report)
    * [`BinaryClassificationResults.report()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.report)
    * [`BinaryClassificationResults.samples`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.samples)
    * [`BinaryClassificationResults.save()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.save)
    * [`BinaryClassificationResults.save_config()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.save_config)
    * [`BinaryClassificationResults.serialize()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.serialize)
    * [`BinaryClassificationResults.to_str()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.to_str)
    * [`BinaryClassificationResults.use_subset()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.use_subset)
    * [`BinaryClassificationResults.write_json()`](fiftyone.utils.eval.classification.md#fiftyone.utils.eval.classification.BinaryClassificationResults.write_json)
* [fiftyone.utils.eval.coco](fiftyone.utils.eval.coco.md)
  * [`COCOEvaluationConfig`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig)
    * [`COCOEvaluationConfig.method`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.method)
    * [`COCOEvaluationConfig.attributes()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.attributes)
    * [`COCOEvaluationConfig.base_config_cls()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.base_config_cls)
    * [`COCOEvaluationConfig.build()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.build)
    * [`COCOEvaluationConfig.builder()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.builder)
    * [`COCOEvaluationConfig.cls`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.cls)
    * [`COCOEvaluationConfig.copy()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.copy)
    * [`COCOEvaluationConfig.custom_attributes()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.custom_attributes)
    * [`COCOEvaluationConfig.default()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.default)
    * [`COCOEvaluationConfig.from_dict()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.from_dict)
    * [`COCOEvaluationConfig.from_json()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.from_json)
    * [`COCOEvaluationConfig.from_kwargs()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.from_kwargs)
    * [`COCOEvaluationConfig.from_str()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.from_str)
    * [`COCOEvaluationConfig.get_class_name()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.get_class_name)
    * [`COCOEvaluationConfig.load_credentials()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.load_credentials)
    * [`COCOEvaluationConfig.load_default()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.load_default)
    * [`COCOEvaluationConfig.parse_array()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.parse_array)
    * [`COCOEvaluationConfig.parse_bool()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.parse_bool)
    * [`COCOEvaluationConfig.parse_categorical()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.parse_categorical)
    * [`COCOEvaluationConfig.parse_dict()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.parse_dict)
    * [`COCOEvaluationConfig.parse_int()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.parse_int)
    * [`COCOEvaluationConfig.parse_mutually_exclusive_fields()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.parse_mutually_exclusive_fields)
    * [`COCOEvaluationConfig.parse_number()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.parse_number)
    * [`COCOEvaluationConfig.parse_object()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.parse_object)
    * [`COCOEvaluationConfig.parse_object_array()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.parse_object_array)
    * [`COCOEvaluationConfig.parse_object_dict()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.parse_object_dict)
    * [`COCOEvaluationConfig.parse_path()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.parse_path)
    * [`COCOEvaluationConfig.parse_raw()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.parse_raw)
    * [`COCOEvaluationConfig.parse_string()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.parse_string)
    * [`COCOEvaluationConfig.requires_additional_fields`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.requires_additional_fields)
    * [`COCOEvaluationConfig.run_cls`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.run_cls)
    * [`COCOEvaluationConfig.serialize()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.serialize)
    * [`COCOEvaluationConfig.to_str()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.to_str)
    * [`COCOEvaluationConfig.type`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.type)
    * [`COCOEvaluationConfig.validate_all_or_nothing_fields()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.validate_all_or_nothing_fields)
    * [`COCOEvaluationConfig.write_json()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig.write_json)
  * [`COCOEvaluation`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation)
    * [`COCOEvaluation.evaluate()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.evaluate)
    * [`COCOEvaluation.generate_results()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.generate_results)
    * [`COCOEvaluation.add_fields_to_sidebar_group()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.add_fields_to_sidebar_group)
    * [`COCOEvaluation.cleanup()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.cleanup)
    * [`COCOEvaluation.cleanup_custom_metrics()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.cleanup_custom_metrics)
    * [`COCOEvaluation.compute_custom_metrics()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.compute_custom_metrics)
    * [`COCOEvaluation.delete_run()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.delete_run)
    * [`COCOEvaluation.delete_runs()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.delete_runs)
    * [`COCOEvaluation.ensure_requirements()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.ensure_requirements)
    * [`COCOEvaluation.ensure_usage_requirements()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.ensure_usage_requirements)
    * [`COCOEvaluation.from_config()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.from_config)
    * [`COCOEvaluation.from_dict()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.from_dict)
    * [`COCOEvaluation.from_json()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.from_json)
    * [`COCOEvaluation.from_kwargs()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.from_kwargs)
    * [`COCOEvaluation.get_custom_metric_fields()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.get_custom_metric_fields)
    * [`COCOEvaluation.get_fields()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.get_fields)
    * [`COCOEvaluation.get_run_info()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.get_run_info)
    * [`COCOEvaluation.has_cached_run_results()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.has_cached_run_results)
    * [`COCOEvaluation.list_runs()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.list_runs)
    * [`COCOEvaluation.load_run_results()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.load_run_results)
    * [`COCOEvaluation.load_run_view()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.load_run_view)
    * [`COCOEvaluation.parse()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.parse)
    * [`COCOEvaluation.register_run()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.register_run)
    * [`COCOEvaluation.register_samples()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.register_samples)
    * [`COCOEvaluation.rename()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.rename)
    * [`COCOEvaluation.rename_custom_metrics()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.rename_custom_metrics)
    * [`COCOEvaluation.run_info_cls()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.run_info_cls)
    * [`COCOEvaluation.save_run_info()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.save_run_info)
    * [`COCOEvaluation.save_run_results()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.save_run_results)
    * [`COCOEvaluation.update_run_config()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.update_run_config)
    * [`COCOEvaluation.update_run_key()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.update_run_key)
    * [`COCOEvaluation.validate()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.validate)
    * [`COCOEvaluation.validate_run()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluation.validate_run)
  * [`COCODetectionResults`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults)
    * [`COCODetectionResults.plot_pr_curves()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.plot_pr_curves)
    * [`COCODetectionResults.mAP()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.mAP)
    * [`COCODetectionResults.mAR()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.mAR)
    * [`COCODetectionResults.add_custom_metrics()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.add_custom_metrics)
    * [`COCODetectionResults.attributes()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.attributes)
    * [`COCODetectionResults.backend`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.backend)
    * [`COCODetectionResults.base_results_cls()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.base_results_cls)
    * [`COCODetectionResults.clear_subset()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.clear_subset)
    * [`COCODetectionResults.cls`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.cls)
    * [`COCODetectionResults.config`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.config)
    * [`COCODetectionResults.confusion_matrix()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.confusion_matrix)
    * [`COCODetectionResults.copy()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.copy)
    * [`COCODetectionResults.custom_attributes()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.custom_attributes)
    * [`COCODetectionResults.from_dict()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.from_dict)
    * [`COCODetectionResults.from_json()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.from_json)
    * [`COCODetectionResults.from_str()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.from_str)
    * [`COCODetectionResults.get_class_name()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.get_class_name)
    * [`COCODetectionResults.get_meta()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.get_meta)
    * [`COCODetectionResults.has_subset`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.has_subset)
    * [`COCODetectionResults.key`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.key)
    * [`COCODetectionResults.metrics()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.metrics)
    * [`COCODetectionResults.plot_confusion_matrix()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.plot_confusion_matrix)
    * [`COCODetectionResults.print_metrics()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.print_metrics)
    * [`COCODetectionResults.print_report()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.print_report)
    * [`COCODetectionResults.report()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.report)
    * [`COCODetectionResults.samples`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.samples)
    * [`COCODetectionResults.save()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.save)
    * [`COCODetectionResults.save_config()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.save_config)
    * [`COCODetectionResults.serialize()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.serialize)
    * [`COCODetectionResults.to_str()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.to_str)
    * [`COCODetectionResults.use_subset()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.use_subset)
    * [`COCODetectionResults.write_json()`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCODetectionResults.write_json)
* [fiftyone.utils.eval.detection](fiftyone.utils.eval.detection.md)
  * [`evaluate_detections()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.evaluate_detections)
  * [`DetectionEvaluationConfig`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig)
    * [`DetectionEvaluationConfig.type`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.type)
    * [`DetectionEvaluationConfig.requires_additional_fields`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.requires_additional_fields)
    * [`DetectionEvaluationConfig.attributes()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.attributes)
    * [`DetectionEvaluationConfig.base_config_cls()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.base_config_cls)
    * [`DetectionEvaluationConfig.build()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.build)
    * [`DetectionEvaluationConfig.builder()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.builder)
    * [`DetectionEvaluationConfig.cls`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.cls)
    * [`DetectionEvaluationConfig.copy()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.copy)
    * [`DetectionEvaluationConfig.custom_attributes()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.custom_attributes)
    * [`DetectionEvaluationConfig.default()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.default)
    * [`DetectionEvaluationConfig.from_dict()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.from_dict)
    * [`DetectionEvaluationConfig.from_json()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.from_json)
    * [`DetectionEvaluationConfig.from_kwargs()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.from_kwargs)
    * [`DetectionEvaluationConfig.from_str()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.from_str)
    * [`DetectionEvaluationConfig.get_class_name()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.get_class_name)
    * [`DetectionEvaluationConfig.load_credentials()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.load_credentials)
    * [`DetectionEvaluationConfig.load_default()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.load_default)
    * [`DetectionEvaluationConfig.method`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.method)
    * [`DetectionEvaluationConfig.parse_array()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.parse_array)
    * [`DetectionEvaluationConfig.parse_bool()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.parse_bool)
    * [`DetectionEvaluationConfig.parse_categorical()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.parse_categorical)
    * [`DetectionEvaluationConfig.parse_dict()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.parse_dict)
    * [`DetectionEvaluationConfig.parse_int()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.parse_int)
    * [`DetectionEvaluationConfig.parse_mutually_exclusive_fields()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.parse_mutually_exclusive_fields)
    * [`DetectionEvaluationConfig.parse_number()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.parse_number)
    * [`DetectionEvaluationConfig.parse_object()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.parse_object)
    * [`DetectionEvaluationConfig.parse_object_array()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.parse_object_array)
    * [`DetectionEvaluationConfig.parse_object_dict()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.parse_object_dict)
    * [`DetectionEvaluationConfig.parse_path()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.parse_path)
    * [`DetectionEvaluationConfig.parse_raw()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.parse_raw)
    * [`DetectionEvaluationConfig.parse_string()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.parse_string)
    * [`DetectionEvaluationConfig.run_cls`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.run_cls)
    * [`DetectionEvaluationConfig.serialize()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.serialize)
    * [`DetectionEvaluationConfig.to_str()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.to_str)
    * [`DetectionEvaluationConfig.validate_all_or_nothing_fields()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.validate_all_or_nothing_fields)
    * [`DetectionEvaluationConfig.write_json()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluationConfig.write_json)
  * [`DetectionEvaluation`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation)
    * [`DetectionEvaluation.register_samples()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.register_samples)
    * [`DetectionEvaluation.evaluate()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.evaluate)
    * [`DetectionEvaluation.generate_results()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.generate_results)
    * [`DetectionEvaluation.get_fields()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.get_fields)
    * [`DetectionEvaluation.rename()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.rename)
    * [`DetectionEvaluation.cleanup()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.cleanup)
    * [`DetectionEvaluation.add_fields_to_sidebar_group()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.add_fields_to_sidebar_group)
    * [`DetectionEvaluation.cleanup_custom_metrics()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.cleanup_custom_metrics)
    * [`DetectionEvaluation.compute_custom_metrics()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.compute_custom_metrics)
    * [`DetectionEvaluation.delete_run()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.delete_run)
    * [`DetectionEvaluation.delete_runs()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.delete_runs)
    * [`DetectionEvaluation.ensure_requirements()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.ensure_requirements)
    * [`DetectionEvaluation.ensure_usage_requirements()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.ensure_usage_requirements)
    * [`DetectionEvaluation.from_config()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.from_config)
    * [`DetectionEvaluation.from_dict()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.from_dict)
    * [`DetectionEvaluation.from_json()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.from_json)
    * [`DetectionEvaluation.from_kwargs()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.from_kwargs)
    * [`DetectionEvaluation.get_custom_metric_fields()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.get_custom_metric_fields)
    * [`DetectionEvaluation.get_run_info()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.get_run_info)
    * [`DetectionEvaluation.has_cached_run_results()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.has_cached_run_results)
    * [`DetectionEvaluation.list_runs()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.list_runs)
    * [`DetectionEvaluation.load_run_results()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.load_run_results)
    * [`DetectionEvaluation.load_run_view()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.load_run_view)
    * [`DetectionEvaluation.parse()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.parse)
    * [`DetectionEvaluation.register_run()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.register_run)
    * [`DetectionEvaluation.rename_custom_metrics()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.rename_custom_metrics)
    * [`DetectionEvaluation.run_info_cls()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.run_info_cls)
    * [`DetectionEvaluation.save_run_info()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.save_run_info)
    * [`DetectionEvaluation.save_run_results()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.save_run_results)
    * [`DetectionEvaluation.update_run_config()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.update_run_config)
    * [`DetectionEvaluation.update_run_key()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.update_run_key)
    * [`DetectionEvaluation.validate()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.validate)
    * [`DetectionEvaluation.validate_run()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionEvaluation.validate_run)
  * [`DetectionResults`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults)
    * [`DetectionResults.add_custom_metrics()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.add_custom_metrics)
    * [`DetectionResults.attributes()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.attributes)
    * [`DetectionResults.backend`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.backend)
    * [`DetectionResults.base_results_cls()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.base_results_cls)
    * [`DetectionResults.clear_subset()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.clear_subset)
    * [`DetectionResults.cls`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.cls)
    * [`DetectionResults.config`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.config)
    * [`DetectionResults.confusion_matrix()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.confusion_matrix)
    * [`DetectionResults.copy()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.copy)
    * [`DetectionResults.custom_attributes()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.custom_attributes)
    * [`DetectionResults.from_dict()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.from_dict)
    * [`DetectionResults.from_json()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.from_json)
    * [`DetectionResults.from_str()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.from_str)
    * [`DetectionResults.get_class_name()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.get_class_name)
    * [`DetectionResults.get_meta()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.get_meta)
    * [`DetectionResults.has_subset`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.has_subset)
    * [`DetectionResults.key`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.key)
    * [`DetectionResults.metrics()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.metrics)
    * [`DetectionResults.plot_confusion_matrix()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.plot_confusion_matrix)
    * [`DetectionResults.print_metrics()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.print_metrics)
    * [`DetectionResults.print_report()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.print_report)
    * [`DetectionResults.report()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.report)
    * [`DetectionResults.samples`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.samples)
    * [`DetectionResults.save()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.save)
    * [`DetectionResults.save_config()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.save_config)
    * [`DetectionResults.serialize()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.serialize)
    * [`DetectionResults.to_str()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.to_str)
    * [`DetectionResults.use_subset()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.use_subset)
    * [`DetectionResults.write_json()`](fiftyone.utils.eval.detection.md#fiftyone.utils.eval.detection.DetectionResults.write_json)
* [fiftyone.utils.eval.openimages](fiftyone.utils.eval.openimages.md)
  * [`OpenImagesEvaluationConfig`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig)
    * [`OpenImagesEvaluationConfig.method`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.method)
    * [`OpenImagesEvaluationConfig.requires_additional_fields`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.requires_additional_fields)
    * [`OpenImagesEvaluationConfig.attributes()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.attributes)
    * [`OpenImagesEvaluationConfig.base_config_cls()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.base_config_cls)
    * [`OpenImagesEvaluationConfig.build()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.build)
    * [`OpenImagesEvaluationConfig.builder()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.builder)
    * [`OpenImagesEvaluationConfig.cls`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.cls)
    * [`OpenImagesEvaluationConfig.copy()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.copy)
    * [`OpenImagesEvaluationConfig.custom_attributes()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.custom_attributes)
    * [`OpenImagesEvaluationConfig.default()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.default)
    * [`OpenImagesEvaluationConfig.from_dict()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.from_dict)
    * [`OpenImagesEvaluationConfig.from_json()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.from_json)
    * [`OpenImagesEvaluationConfig.from_kwargs()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.from_kwargs)
    * [`OpenImagesEvaluationConfig.from_str()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.from_str)
    * [`OpenImagesEvaluationConfig.get_class_name()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.get_class_name)
    * [`OpenImagesEvaluationConfig.load_credentials()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.load_credentials)
    * [`OpenImagesEvaluationConfig.load_default()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.load_default)
    * [`OpenImagesEvaluationConfig.parse_array()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.parse_array)
    * [`OpenImagesEvaluationConfig.parse_bool()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.parse_bool)
    * [`OpenImagesEvaluationConfig.parse_categorical()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.parse_categorical)
    * [`OpenImagesEvaluationConfig.parse_dict()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.parse_dict)
    * [`OpenImagesEvaluationConfig.parse_int()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.parse_int)
    * [`OpenImagesEvaluationConfig.parse_mutually_exclusive_fields()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.parse_mutually_exclusive_fields)
    * [`OpenImagesEvaluationConfig.parse_number()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.parse_number)
    * [`OpenImagesEvaluationConfig.parse_object()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.parse_object)
    * [`OpenImagesEvaluationConfig.parse_object_array()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.parse_object_array)
    * [`OpenImagesEvaluationConfig.parse_object_dict()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.parse_object_dict)
    * [`OpenImagesEvaluationConfig.parse_path()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.parse_path)
    * [`OpenImagesEvaluationConfig.parse_raw()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.parse_raw)
    * [`OpenImagesEvaluationConfig.parse_string()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.parse_string)
    * [`OpenImagesEvaluationConfig.run_cls`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.run_cls)
    * [`OpenImagesEvaluationConfig.serialize()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.serialize)
    * [`OpenImagesEvaluationConfig.to_str()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.to_str)
    * [`OpenImagesEvaluationConfig.type`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.type)
    * [`OpenImagesEvaluationConfig.validate_all_or_nothing_fields()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.validate_all_or_nothing_fields)
    * [`OpenImagesEvaluationConfig.write_json()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.write_json)
  * [`OpenImagesEvaluation`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation)
    * [`OpenImagesEvaluation.evaluate()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.evaluate)
    * [`OpenImagesEvaluation.generate_results()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.generate_results)
    * [`OpenImagesEvaluation.add_fields_to_sidebar_group()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.add_fields_to_sidebar_group)
    * [`OpenImagesEvaluation.cleanup()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.cleanup)
    * [`OpenImagesEvaluation.cleanup_custom_metrics()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.cleanup_custom_metrics)
    * [`OpenImagesEvaluation.compute_custom_metrics()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.compute_custom_metrics)
    * [`OpenImagesEvaluation.delete_run()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.delete_run)
    * [`OpenImagesEvaluation.delete_runs()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.delete_runs)
    * [`OpenImagesEvaluation.ensure_requirements()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.ensure_requirements)
    * [`OpenImagesEvaluation.ensure_usage_requirements()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.ensure_usage_requirements)
    * [`OpenImagesEvaluation.from_config()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.from_config)
    * [`OpenImagesEvaluation.from_dict()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.from_dict)
    * [`OpenImagesEvaluation.from_json()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.from_json)
    * [`OpenImagesEvaluation.from_kwargs()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.from_kwargs)
    * [`OpenImagesEvaluation.get_custom_metric_fields()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.get_custom_metric_fields)
    * [`OpenImagesEvaluation.get_fields()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.get_fields)
    * [`OpenImagesEvaluation.get_run_info()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.get_run_info)
    * [`OpenImagesEvaluation.has_cached_run_results()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.has_cached_run_results)
    * [`OpenImagesEvaluation.list_runs()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.list_runs)
    * [`OpenImagesEvaluation.load_run_results()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.load_run_results)
    * [`OpenImagesEvaluation.load_run_view()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.load_run_view)
    * [`OpenImagesEvaluation.parse()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.parse)
    * [`OpenImagesEvaluation.register_run()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.register_run)
    * [`OpenImagesEvaluation.register_samples()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.register_samples)
    * [`OpenImagesEvaluation.rename()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.rename)
    * [`OpenImagesEvaluation.rename_custom_metrics()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.rename_custom_metrics)
    * [`OpenImagesEvaluation.run_info_cls()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.run_info_cls)
    * [`OpenImagesEvaluation.save_run_info()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.save_run_info)
    * [`OpenImagesEvaluation.save_run_results()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.save_run_results)
    * [`OpenImagesEvaluation.update_run_config()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.update_run_config)
    * [`OpenImagesEvaluation.update_run_key()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.update_run_key)
    * [`OpenImagesEvaluation.validate()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.validate)
    * [`OpenImagesEvaluation.validate_run()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluation.validate_run)
  * [`OpenImagesDetectionResults`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults)
    * [`OpenImagesDetectionResults.plot_pr_curves()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.plot_pr_curves)
    * [`OpenImagesDetectionResults.mAP()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.mAP)
    * [`OpenImagesDetectionResults.add_custom_metrics()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.add_custom_metrics)
    * [`OpenImagesDetectionResults.attributes()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.attributes)
    * [`OpenImagesDetectionResults.backend`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.backend)
    * [`OpenImagesDetectionResults.base_results_cls()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.base_results_cls)
    * [`OpenImagesDetectionResults.clear_subset()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.clear_subset)
    * [`OpenImagesDetectionResults.cls`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.cls)
    * [`OpenImagesDetectionResults.config`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.config)
    * [`OpenImagesDetectionResults.confusion_matrix()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.confusion_matrix)
    * [`OpenImagesDetectionResults.copy()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.copy)
    * [`OpenImagesDetectionResults.custom_attributes()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.custom_attributes)
    * [`OpenImagesDetectionResults.from_dict()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.from_dict)
    * [`OpenImagesDetectionResults.from_json()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.from_json)
    * [`OpenImagesDetectionResults.from_str()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.from_str)
    * [`OpenImagesDetectionResults.get_class_name()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.get_class_name)
    * [`OpenImagesDetectionResults.get_meta()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.get_meta)
    * [`OpenImagesDetectionResults.has_subset`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.has_subset)
    * [`OpenImagesDetectionResults.key`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.key)
    * [`OpenImagesDetectionResults.metrics()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.metrics)
    * [`OpenImagesDetectionResults.plot_confusion_matrix()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.plot_confusion_matrix)
    * [`OpenImagesDetectionResults.print_metrics()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.print_metrics)
    * [`OpenImagesDetectionResults.print_report()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.print_report)
    * [`OpenImagesDetectionResults.report()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.report)
    * [`OpenImagesDetectionResults.samples`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.samples)
    * [`OpenImagesDetectionResults.save()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.save)
    * [`OpenImagesDetectionResults.save_config()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.save_config)
    * [`OpenImagesDetectionResults.serialize()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.serialize)
    * [`OpenImagesDetectionResults.to_str()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.to_str)
    * [`OpenImagesDetectionResults.use_subset()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.use_subset)
    * [`OpenImagesDetectionResults.write_json()`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesDetectionResults.write_json)
* [fiftyone.utils.eval.regression](fiftyone.utils.eval.regression.md)
  * [`evaluate_regressions()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.evaluate_regressions)
  * [`RegressionEvaluationConfig`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig)
    * [`RegressionEvaluationConfig.type`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.type)
    * [`RegressionEvaluationConfig.attributes()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.attributes)
    * [`RegressionEvaluationConfig.base_config_cls()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.base_config_cls)
    * [`RegressionEvaluationConfig.build()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.build)
    * [`RegressionEvaluationConfig.builder()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.builder)
    * [`RegressionEvaluationConfig.cls`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.cls)
    * [`RegressionEvaluationConfig.copy()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.copy)
    * [`RegressionEvaluationConfig.custom_attributes()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.custom_attributes)
    * [`RegressionEvaluationConfig.default()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.default)
    * [`RegressionEvaluationConfig.from_dict()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.from_dict)
    * [`RegressionEvaluationConfig.from_json()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.from_json)
    * [`RegressionEvaluationConfig.from_kwargs()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.from_kwargs)
    * [`RegressionEvaluationConfig.from_str()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.from_str)
    * [`RegressionEvaluationConfig.get_class_name()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.get_class_name)
    * [`RegressionEvaluationConfig.load_credentials()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.load_credentials)
    * [`RegressionEvaluationConfig.load_default()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.load_default)
    * [`RegressionEvaluationConfig.method`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.method)
    * [`RegressionEvaluationConfig.parse_array()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_array)
    * [`RegressionEvaluationConfig.parse_bool()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_bool)
    * [`RegressionEvaluationConfig.parse_categorical()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_categorical)
    * [`RegressionEvaluationConfig.parse_dict()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_dict)
    * [`RegressionEvaluationConfig.parse_int()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_int)
    * [`RegressionEvaluationConfig.parse_mutually_exclusive_fields()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_mutually_exclusive_fields)
    * [`RegressionEvaluationConfig.parse_number()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_number)
    * [`RegressionEvaluationConfig.parse_object()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_object)
    * [`RegressionEvaluationConfig.parse_object_array()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_object_array)
    * [`RegressionEvaluationConfig.parse_object_dict()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_object_dict)
    * [`RegressionEvaluationConfig.parse_path()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_path)
    * [`RegressionEvaluationConfig.parse_raw()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_raw)
    * [`RegressionEvaluationConfig.parse_string()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.parse_string)
    * [`RegressionEvaluationConfig.run_cls`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.run_cls)
    * [`RegressionEvaluationConfig.serialize()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.serialize)
    * [`RegressionEvaluationConfig.to_str()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.to_str)
    * [`RegressionEvaluationConfig.validate_all_or_nothing_fields()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.validate_all_or_nothing_fields)
    * [`RegressionEvaluationConfig.write_json()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluationConfig.write_json)
  * [`RegressionEvaluation`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation)
    * [`RegressionEvaluation.register_samples()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.register_samples)
    * [`RegressionEvaluation.evaluate_samples()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.evaluate_samples)
    * [`RegressionEvaluation.get_fields()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.get_fields)
    * [`RegressionEvaluation.rename()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.rename)
    * [`RegressionEvaluation.cleanup()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.cleanup)
    * [`RegressionEvaluation.add_fields_to_sidebar_group()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.add_fields_to_sidebar_group)
    * [`RegressionEvaluation.cleanup_custom_metrics()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.cleanup_custom_metrics)
    * [`RegressionEvaluation.compute_custom_metrics()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.compute_custom_metrics)
    * [`RegressionEvaluation.delete_run()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.delete_run)
    * [`RegressionEvaluation.delete_runs()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.delete_runs)
    * [`RegressionEvaluation.ensure_requirements()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.ensure_requirements)
    * [`RegressionEvaluation.ensure_usage_requirements()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.ensure_usage_requirements)
    * [`RegressionEvaluation.from_config()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.from_config)
    * [`RegressionEvaluation.from_dict()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.from_dict)
    * [`RegressionEvaluation.from_json()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.from_json)
    * [`RegressionEvaluation.from_kwargs()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.from_kwargs)
    * [`RegressionEvaluation.get_custom_metric_fields()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.get_custom_metric_fields)
    * [`RegressionEvaluation.get_run_info()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.get_run_info)
    * [`RegressionEvaluation.has_cached_run_results()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.has_cached_run_results)
    * [`RegressionEvaluation.list_runs()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.list_runs)
    * [`RegressionEvaluation.load_run_results()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.load_run_results)
    * [`RegressionEvaluation.load_run_view()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.load_run_view)
    * [`RegressionEvaluation.parse()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.parse)
    * [`RegressionEvaluation.register_run()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.register_run)
    * [`RegressionEvaluation.rename_custom_metrics()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.rename_custom_metrics)
    * [`RegressionEvaluation.run_info_cls()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.run_info_cls)
    * [`RegressionEvaluation.save_run_info()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.save_run_info)
    * [`RegressionEvaluation.save_run_results()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.save_run_results)
    * [`RegressionEvaluation.update_run_config()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.update_run_config)
    * [`RegressionEvaluation.update_run_key()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.update_run_key)
    * [`RegressionEvaluation.validate()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.validate)
    * [`RegressionEvaluation.validate_run()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionEvaluation.validate_run)
  * [`SimpleEvaluationConfig`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig)
    * [`SimpleEvaluationConfig.method`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.method)
    * [`SimpleEvaluationConfig.metric`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.metric)
    * [`SimpleEvaluationConfig.attributes()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.attributes)
    * [`SimpleEvaluationConfig.base_config_cls()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.base_config_cls)
    * [`SimpleEvaluationConfig.build()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.build)
    * [`SimpleEvaluationConfig.builder()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.builder)
    * [`SimpleEvaluationConfig.cls`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.cls)
    * [`SimpleEvaluationConfig.copy()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.copy)
    * [`SimpleEvaluationConfig.custom_attributes()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.custom_attributes)
    * [`SimpleEvaluationConfig.default()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.default)
    * [`SimpleEvaluationConfig.from_dict()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.from_dict)
    * [`SimpleEvaluationConfig.from_json()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.from_json)
    * [`SimpleEvaluationConfig.from_kwargs()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.from_kwargs)
    * [`SimpleEvaluationConfig.from_str()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.from_str)
    * [`SimpleEvaluationConfig.get_class_name()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.get_class_name)
    * [`SimpleEvaluationConfig.load_credentials()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.load_credentials)
    * [`SimpleEvaluationConfig.load_default()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.load_default)
    * [`SimpleEvaluationConfig.parse_array()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_array)
    * [`SimpleEvaluationConfig.parse_bool()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_bool)
    * [`SimpleEvaluationConfig.parse_categorical()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_categorical)
    * [`SimpleEvaluationConfig.parse_dict()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_dict)
    * [`SimpleEvaluationConfig.parse_int()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_int)
    * [`SimpleEvaluationConfig.parse_mutually_exclusive_fields()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_mutually_exclusive_fields)
    * [`SimpleEvaluationConfig.parse_number()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_number)
    * [`SimpleEvaluationConfig.parse_object()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_object)
    * [`SimpleEvaluationConfig.parse_object_array()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_object_array)
    * [`SimpleEvaluationConfig.parse_object_dict()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_object_dict)
    * [`SimpleEvaluationConfig.parse_path()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_path)
    * [`SimpleEvaluationConfig.parse_raw()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_raw)
    * [`SimpleEvaluationConfig.parse_string()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.parse_string)
    * [`SimpleEvaluationConfig.run_cls`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.run_cls)
    * [`SimpleEvaluationConfig.serialize()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.serialize)
    * [`SimpleEvaluationConfig.to_str()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.to_str)
    * [`SimpleEvaluationConfig.type`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.type)
    * [`SimpleEvaluationConfig.validate_all_or_nothing_fields()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.validate_all_or_nothing_fields)
    * [`SimpleEvaluationConfig.write_json()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluationConfig.write_json)
  * [`SimpleEvaluation`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation)
    * [`SimpleEvaluation.evaluate_samples()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.evaluate_samples)
    * [`SimpleEvaluation.add_fields_to_sidebar_group()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.add_fields_to_sidebar_group)
    * [`SimpleEvaluation.cleanup()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.cleanup)
    * [`SimpleEvaluation.cleanup_custom_metrics()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.cleanup_custom_metrics)
    * [`SimpleEvaluation.compute_custom_metrics()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.compute_custom_metrics)
    * [`SimpleEvaluation.delete_run()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.delete_run)
    * [`SimpleEvaluation.delete_runs()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.delete_runs)
    * [`SimpleEvaluation.ensure_requirements()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.ensure_requirements)
    * [`SimpleEvaluation.ensure_usage_requirements()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.ensure_usage_requirements)
    * [`SimpleEvaluation.from_config()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.from_config)
    * [`SimpleEvaluation.from_dict()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.from_dict)
    * [`SimpleEvaluation.from_json()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.from_json)
    * [`SimpleEvaluation.from_kwargs()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.from_kwargs)
    * [`SimpleEvaluation.get_custom_metric_fields()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.get_custom_metric_fields)
    * [`SimpleEvaluation.get_fields()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.get_fields)
    * [`SimpleEvaluation.get_run_info()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.get_run_info)
    * [`SimpleEvaluation.has_cached_run_results()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.has_cached_run_results)
    * [`SimpleEvaluation.list_runs()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.list_runs)
    * [`SimpleEvaluation.load_run_results()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.load_run_results)
    * [`SimpleEvaluation.load_run_view()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.load_run_view)
    * [`SimpleEvaluation.parse()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.parse)
    * [`SimpleEvaluation.register_run()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.register_run)
    * [`SimpleEvaluation.register_samples()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.register_samples)
    * [`SimpleEvaluation.rename()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.rename)
    * [`SimpleEvaluation.rename_custom_metrics()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.rename_custom_metrics)
    * [`SimpleEvaluation.run_info_cls()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.run_info_cls)
    * [`SimpleEvaluation.save_run_info()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.save_run_info)
    * [`SimpleEvaluation.save_run_results()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.save_run_results)
    * [`SimpleEvaluation.update_run_config()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.update_run_config)
    * [`SimpleEvaluation.update_run_key()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.update_run_key)
    * [`SimpleEvaluation.validate()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.validate)
    * [`SimpleEvaluation.validate_run()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.SimpleEvaluation.validate_run)
  * [`RegressionResults`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults)
    * [`RegressionResults.metrics()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.metrics)
    * [`RegressionResults.print_metrics()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.print_metrics)
    * [`RegressionResults.plot_results()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.plot_results)
    * [`RegressionResults.add_custom_metrics()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.add_custom_metrics)
    * [`RegressionResults.attributes()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.attributes)
    * [`RegressionResults.backend`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.backend)
    * [`RegressionResults.base_results_cls()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.base_results_cls)
    * [`RegressionResults.cls`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.cls)
    * [`RegressionResults.config`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.config)
    * [`RegressionResults.copy()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.copy)
    * [`RegressionResults.custom_attributes()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.custom_attributes)
    * [`RegressionResults.from_dict()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.from_dict)
    * [`RegressionResults.from_json()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.from_json)
    * [`RegressionResults.from_str()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.from_str)
    * [`RegressionResults.get_class_name()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.get_class_name)
    * [`RegressionResults.get_meta()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.get_meta)
    * [`RegressionResults.key`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.key)
    * [`RegressionResults.samples`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.samples)
    * [`RegressionResults.save()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.save)
    * [`RegressionResults.save_config()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.save_config)
    * [`RegressionResults.serialize()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.serialize)
    * [`RegressionResults.to_str()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.to_str)
    * [`RegressionResults.write_json()`](fiftyone.utils.eval.regression.md#fiftyone.utils.eval.regression.RegressionResults.write_json)
* [fiftyone.utils.eval.segmentation](fiftyone.utils.eval.segmentation.md)
  * [`evaluate_segmentations()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.evaluate_segmentations)
  * [`SegmentationEvaluationConfig`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig)
    * [`SegmentationEvaluationConfig.type`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.type)
    * [`SegmentationEvaluationConfig.attributes()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.attributes)
    * [`SegmentationEvaluationConfig.base_config_cls()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.base_config_cls)
    * [`SegmentationEvaluationConfig.build()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.build)
    * [`SegmentationEvaluationConfig.builder()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.builder)
    * [`SegmentationEvaluationConfig.cls`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.cls)
    * [`SegmentationEvaluationConfig.copy()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.copy)
    * [`SegmentationEvaluationConfig.custom_attributes()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.custom_attributes)
    * [`SegmentationEvaluationConfig.default()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.default)
    * [`SegmentationEvaluationConfig.from_dict()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.from_dict)
    * [`SegmentationEvaluationConfig.from_json()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.from_json)
    * [`SegmentationEvaluationConfig.from_kwargs()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.from_kwargs)
    * [`SegmentationEvaluationConfig.from_str()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.from_str)
    * [`SegmentationEvaluationConfig.get_class_name()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.get_class_name)
    * [`SegmentationEvaluationConfig.load_credentials()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.load_credentials)
    * [`SegmentationEvaluationConfig.load_default()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.load_default)
    * [`SegmentationEvaluationConfig.method`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.method)
    * [`SegmentationEvaluationConfig.parse_array()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.parse_array)
    * [`SegmentationEvaluationConfig.parse_bool()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.parse_bool)
    * [`SegmentationEvaluationConfig.parse_categorical()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.parse_categorical)
    * [`SegmentationEvaluationConfig.parse_dict()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.parse_dict)
    * [`SegmentationEvaluationConfig.parse_int()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.parse_int)
    * [`SegmentationEvaluationConfig.parse_mutually_exclusive_fields()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.parse_mutually_exclusive_fields)
    * [`SegmentationEvaluationConfig.parse_number()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.parse_number)
    * [`SegmentationEvaluationConfig.parse_object()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.parse_object)
    * [`SegmentationEvaluationConfig.parse_object_array()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.parse_object_array)
    * [`SegmentationEvaluationConfig.parse_object_dict()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.parse_object_dict)
    * [`SegmentationEvaluationConfig.parse_path()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.parse_path)
    * [`SegmentationEvaluationConfig.parse_raw()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.parse_raw)
    * [`SegmentationEvaluationConfig.parse_string()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.parse_string)
    * [`SegmentationEvaluationConfig.run_cls`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.run_cls)
    * [`SegmentationEvaluationConfig.serialize()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.serialize)
    * [`SegmentationEvaluationConfig.to_str()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.to_str)
    * [`SegmentationEvaluationConfig.validate_all_or_nothing_fields()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.validate_all_or_nothing_fields)
    * [`SegmentationEvaluationConfig.write_json()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.write_json)
  * [`SegmentationEvaluation`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation)
    * [`SegmentationEvaluation.register_samples()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.register_samples)
    * [`SegmentationEvaluation.evaluate_samples()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.evaluate_samples)
    * [`SegmentationEvaluation.get_fields()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.get_fields)
    * [`SegmentationEvaluation.rename()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.rename)
    * [`SegmentationEvaluation.cleanup()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.cleanup)
    * [`SegmentationEvaluation.add_fields_to_sidebar_group()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.add_fields_to_sidebar_group)
    * [`SegmentationEvaluation.cleanup_custom_metrics()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.cleanup_custom_metrics)
    * [`SegmentationEvaluation.compute_custom_metrics()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.compute_custom_metrics)
    * [`SegmentationEvaluation.delete_run()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.delete_run)
    * [`SegmentationEvaluation.delete_runs()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.delete_runs)
    * [`SegmentationEvaluation.ensure_requirements()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.ensure_requirements)
    * [`SegmentationEvaluation.ensure_usage_requirements()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.ensure_usage_requirements)
    * [`SegmentationEvaluation.from_config()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.from_config)
    * [`SegmentationEvaluation.from_dict()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.from_dict)
    * [`SegmentationEvaluation.from_json()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.from_json)
    * [`SegmentationEvaluation.from_kwargs()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.from_kwargs)
    * [`SegmentationEvaluation.get_custom_metric_fields()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.get_custom_metric_fields)
    * [`SegmentationEvaluation.get_run_info()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.get_run_info)
    * [`SegmentationEvaluation.has_cached_run_results()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.has_cached_run_results)
    * [`SegmentationEvaluation.list_runs()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.list_runs)
    * [`SegmentationEvaluation.load_run_results()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.load_run_results)
    * [`SegmentationEvaluation.load_run_view()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.load_run_view)
    * [`SegmentationEvaluation.parse()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.parse)
    * [`SegmentationEvaluation.register_run()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.register_run)
    * [`SegmentationEvaluation.rename_custom_metrics()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.rename_custom_metrics)
    * [`SegmentationEvaluation.run_info_cls()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.run_info_cls)
    * [`SegmentationEvaluation.save_run_info()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.save_run_info)
    * [`SegmentationEvaluation.save_run_results()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.save_run_results)
    * [`SegmentationEvaluation.update_run_config()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.update_run_config)
    * [`SegmentationEvaluation.update_run_key()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.update_run_key)
    * [`SegmentationEvaluation.validate()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.validate)
    * [`SegmentationEvaluation.validate_run()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationEvaluation.validate_run)
  * [`SimpleEvaluationConfig`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig)
    * [`SimpleEvaluationConfig.method`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.method)
    * [`SimpleEvaluationConfig.attributes()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.attributes)
    * [`SimpleEvaluationConfig.base_config_cls()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.base_config_cls)
    * [`SimpleEvaluationConfig.build()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.build)
    * [`SimpleEvaluationConfig.builder()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.builder)
    * [`SimpleEvaluationConfig.cls`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.cls)
    * [`SimpleEvaluationConfig.copy()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.copy)
    * [`SimpleEvaluationConfig.custom_attributes()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.custom_attributes)
    * [`SimpleEvaluationConfig.default()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.default)
    * [`SimpleEvaluationConfig.from_dict()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.from_dict)
    * [`SimpleEvaluationConfig.from_json()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.from_json)
    * [`SimpleEvaluationConfig.from_kwargs()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.from_kwargs)
    * [`SimpleEvaluationConfig.from_str()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.from_str)
    * [`SimpleEvaluationConfig.get_class_name()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.get_class_name)
    * [`SimpleEvaluationConfig.load_credentials()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.load_credentials)
    * [`SimpleEvaluationConfig.load_default()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.load_default)
    * [`SimpleEvaluationConfig.parse_array()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.parse_array)
    * [`SimpleEvaluationConfig.parse_bool()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.parse_bool)
    * [`SimpleEvaluationConfig.parse_categorical()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.parse_categorical)
    * [`SimpleEvaluationConfig.parse_dict()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.parse_dict)
    * [`SimpleEvaluationConfig.parse_int()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.parse_int)
    * [`SimpleEvaluationConfig.parse_mutually_exclusive_fields()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.parse_mutually_exclusive_fields)
    * [`SimpleEvaluationConfig.parse_number()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.parse_number)
    * [`SimpleEvaluationConfig.parse_object()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.parse_object)
    * [`SimpleEvaluationConfig.parse_object_array()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.parse_object_array)
    * [`SimpleEvaluationConfig.parse_object_dict()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.parse_object_dict)
    * [`SimpleEvaluationConfig.parse_path()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.parse_path)
    * [`SimpleEvaluationConfig.parse_raw()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.parse_raw)
    * [`SimpleEvaluationConfig.parse_string()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.parse_string)
    * [`SimpleEvaluationConfig.run_cls`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.run_cls)
    * [`SimpleEvaluationConfig.serialize()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.serialize)
    * [`SimpleEvaluationConfig.to_str()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.to_str)
    * [`SimpleEvaluationConfig.type`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.type)
    * [`SimpleEvaluationConfig.validate_all_or_nothing_fields()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.validate_all_or_nothing_fields)
    * [`SimpleEvaluationConfig.write_json()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.write_json)
  * [`SimpleEvaluation`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation)
    * [`SimpleEvaluation.evaluate_samples()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.evaluate_samples)
    * [`SimpleEvaluation.add_fields_to_sidebar_group()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.add_fields_to_sidebar_group)
    * [`SimpleEvaluation.cleanup()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.cleanup)
    * [`SimpleEvaluation.cleanup_custom_metrics()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.cleanup_custom_metrics)
    * [`SimpleEvaluation.compute_custom_metrics()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.compute_custom_metrics)
    * [`SimpleEvaluation.delete_run()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.delete_run)
    * [`SimpleEvaluation.delete_runs()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.delete_runs)
    * [`SimpleEvaluation.ensure_requirements()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.ensure_requirements)
    * [`SimpleEvaluation.ensure_usage_requirements()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.ensure_usage_requirements)
    * [`SimpleEvaluation.from_config()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.from_config)
    * [`SimpleEvaluation.from_dict()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.from_dict)
    * [`SimpleEvaluation.from_json()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.from_json)
    * [`SimpleEvaluation.from_kwargs()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.from_kwargs)
    * [`SimpleEvaluation.get_custom_metric_fields()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.get_custom_metric_fields)
    * [`SimpleEvaluation.get_fields()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.get_fields)
    * [`SimpleEvaluation.get_run_info()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.get_run_info)
    * [`SimpleEvaluation.has_cached_run_results()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.has_cached_run_results)
    * [`SimpleEvaluation.list_runs()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.list_runs)
    * [`SimpleEvaluation.load_run_results()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.load_run_results)
    * [`SimpleEvaluation.load_run_view()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.load_run_view)
    * [`SimpleEvaluation.parse()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.parse)
    * [`SimpleEvaluation.register_run()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.register_run)
    * [`SimpleEvaluation.register_samples()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.register_samples)
    * [`SimpleEvaluation.rename()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.rename)
    * [`SimpleEvaluation.rename_custom_metrics()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.rename_custom_metrics)
    * [`SimpleEvaluation.run_info_cls()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.run_info_cls)
    * [`SimpleEvaluation.save_run_info()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.save_run_info)
    * [`SimpleEvaluation.save_run_results()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.save_run_results)
    * [`SimpleEvaluation.update_run_config()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.update_run_config)
    * [`SimpleEvaluation.update_run_key()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.update_run_key)
    * [`SimpleEvaluation.validate()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.validate)
    * [`SimpleEvaluation.validate_run()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SimpleEvaluation.validate_run)
  * [`SegmentationResults`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults)
    * [`SegmentationResults.dice_score()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.dice_score)
    * [`SegmentationResults.add_custom_metrics()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.add_custom_metrics)
    * [`SegmentationResults.attributes()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.attributes)
    * [`SegmentationResults.backend`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.backend)
    * [`SegmentationResults.base_results_cls()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.base_results_cls)
    * [`SegmentationResults.clear_subset()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.clear_subset)
    * [`SegmentationResults.cls`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.cls)
    * [`SegmentationResults.config`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.config)
    * [`SegmentationResults.confusion_matrix()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.confusion_matrix)
    * [`SegmentationResults.copy()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.copy)
    * [`SegmentationResults.custom_attributes()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.custom_attributes)
    * [`SegmentationResults.from_dict()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.from_dict)
    * [`SegmentationResults.from_json()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.from_json)
    * [`SegmentationResults.from_str()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.from_str)
    * [`SegmentationResults.get_class_name()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.get_class_name)
    * [`SegmentationResults.get_meta()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.get_meta)
    * [`SegmentationResults.has_subset`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.has_subset)
    * [`SegmentationResults.key`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.key)
    * [`SegmentationResults.metrics()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.metrics)
    * [`SegmentationResults.plot_confusion_matrix()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.plot_confusion_matrix)
    * [`SegmentationResults.print_metrics()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.print_metrics)
    * [`SegmentationResults.print_report()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.print_report)
    * [`SegmentationResults.report()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.report)
    * [`SegmentationResults.samples`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.samples)
    * [`SegmentationResults.save()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.save)
    * [`SegmentationResults.save_config()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.save_config)
    * [`SegmentationResults.serialize()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.serialize)
    * [`SegmentationResults.to_str()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.to_str)
    * [`SegmentationResults.use_subset()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.use_subset)
    * [`SegmentationResults.write_json()`](fiftyone.utils.eval.segmentation.md#fiftyone.utils.eval.segmentation.SegmentationResults.write_json)

## Module contents

Evaluation utilities.

Copyright 2017-2026, Voxel51, Inc.
<br/>
[voxel51.com](https://voxel51.com/)
<br/>
<br/>

**Functions:**

| [`get_subset_view`](#fiftyone.utils.eval.get_subset_view)(sample_collection, gt_field, ...)      | Returns the view into the given collection specified by the subset definition.                                                |
|--------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
| [`evaluate_classifications`](#fiftyone.utils.eval.evaluate_classifications)(samples, pred_field) | Evaluates the classification predictions in the given collection with respect to the specified ground truth labels.           |
| [`evaluate_detections`](#fiftyone.utils.eval.evaluate_detections)(samples, pred_field[, ...])    | Evaluates the predicted detections in the given samples with respect to the specified ground truth detections.                |
| [`evaluate_regressions`](#fiftyone.utils.eval.evaluate_regressions)(samples, pred_field[, ...])  | Evaluates the regression predictions in the given collection with respect to the specified ground truth values.               |
| [`evaluate_segmentations`](#fiftyone.utils.eval.evaluate_segmentations)(samples, pred_field)     | Evaluates the specified semantic segmentation masks in the given collection with respect to the specified ground truth masks. |

**Classes:**

| [`ClassificationEvaluationConfig`](#fiftyone.utils.eval.ClassificationEvaluationConfig)(pred_field, ...)   | Base class for configuring `ClassificationEvaluation` instances.   |
|------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| [`ClassificationResults`](#fiftyone.utils.eval.ClassificationResults)(samples, config, ...)                | Class that stores the results of a classification evaluation.      |
| [`DetectionEvaluationConfig`](#fiftyone.utils.eval.DetectionEvaluationConfig)(pred_field, gt_field)        | Base class for configuring `DetectionEvaluation` instances.        |
| [`DetectionResults`](#fiftyone.utils.eval.DetectionResults)(samples, config, eval_key, ...)                | Class that stores the results of a detection evaluation.           |
| [`RegressionEvaluationConfig`](#fiftyone.utils.eval.RegressionEvaluationConfig)(pred_field, gt_field)      | Base class for configuring `RegressionEvaluation` instances.       |
| [`RegressionResults`](#fiftyone.utils.eval.RegressionResults)(samples, config, eval_key, ...)              | Class that stores the results of a regression evaluation.          |
| [`SegmentationEvaluationConfig`](#fiftyone.utils.eval.SegmentationEvaluationConfig)(pred_field, ...)       | Base class for configuring `SegmentationEvaluation` instances.     |
| [`SegmentationResults`](#fiftyone.utils.eval.SegmentationResults)(samples, config, ...[, ...])             | Class that stores the results of a segmentation evaluation.        |

### fiftyone.utils.eval.get_subset_view(sample_collection, gt_field, subset_def)

Returns the view into the given collection specified by the subset
definition.

Example subset definitions:

```default
# Subset defined by a saved view
subset_def = {
    "type": "view",
    "view": "night_view",
}

# Subset defined by a sample field value
subset_def = {
    "type": "sample",
    "field": "timeofday",
    "value": "night",
}

# Subset defined by a sample field expression
subset_def = {
    "type": "field",
    "expr": F("uniqueness") > 0.75,
}

# Subset defined by a label attribute value
subset_def = {
    "type": "attribute",
    "field": "type",
    "value": "sedan",
}

# Subset defined by a label expression
bbox_area = F("bounding_box")[2] * F("bounding_box")[3]
subset_def = {
    "type": "attribute",
    "expr": (0.05 <= bbox_area) & (bbox_area <= 0.5),
}

# Compound subset defined by a sample field value + sample expression
subset_def = [
    {
        "type": "field",
        "field": "timeofday",
        "value": "night",
    },
    {
        "type": "field",
        "expr": F("uniqueness") > 0.75,
    },
]

# Compound subset defined by a sample field value + label expression
bbox_area = F("bounding_box")[2] * F("bounding_box")[3]
subset_def = [
    {
        "type": "field",
        "field": "timeofday",
        "value": "night",
    },
    {
        "type": "attribute",
        "expr": (0.05 <= bbox_area) & (bbox_area <= 0.5),
    },
]

# Compound subset defined by a saved view + label attribute value
subset_def = [
    {
        "type": "view",
        "view": "night_view",
    },
    {
        "type": "attribute",
        "field": "type",
        "value": "sedan",
    }
]
```

* **Parameters:**
  * **sample_collection** – a
    [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
  * **gt_field** – the ground truth field
  * **subset_def** – a dict or list of dicts defining the subset. See above for
    syntax and examples
* **Returns:**
  a [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView)

### fiftyone.utils.eval.evaluate_classifications(samples, pred_field, gt_field='ground_truth', eval_key=None, classes=None, missing=None, method=None, custom_metrics=None, progress=None, \*\*kwargs)

Evaluates the classification predictions in the given collection with
respect to the specified ground truth labels.

By default, this method simply compares the ground truth and prediction
for each sample, but other strategies such as binary evaluation and
top-k matching can be configured via the `method` parameter.

You can customize the evaluation method by passing additional
parameters for the method’s config class as `kwargs`.

The natively provided `method` values and their associated configs are:

- `"simple"`: `SimpleEvaluationConfig`
- `"top-k"`: `TopKEvaluationConfig`
- `"binary"`: `BinaryEvaluationConfig`

If an `eval_key` is specified, then this method will record some
statistics on each sample:

- When evaluating sample-level fields, an `eval_key` field will be
  populated on each sample recording whether that sample’s prediction is
  correct.
- When evaluating frame-level fields, an `eval_key` field will be
  populated on each frame recording whether that frame’s prediction is
  correct. In addition, an `eval_key` field will be populated on each
  sample that records the average accuracy of the frame predictions of
  the sample.

* **Parameters:**
  * **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
  * **pred_field** – the name of the field containing the predicted
    [`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification) instances
  * **gt_field** ( *"ground_truth"*) – the name of the field containing the ground
    truth [`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification) instances
  * **eval_key** (*None*) – an evaluation key to use to refer to this evaluation
  * **classes** (*None*) – the list of possible classes. If not provided, the
    observed ground truth/predicted labels are used
  * **missing** (*None*) – a missing label string. Any None-valued labels are
    given this label for results purposes
  * **method** (*None*) – a string specifying the evaluation method to use. The
    supported values are
    `fo.evaluation_config.classification_backends.keys()` and the
    default is `fo.evaluation_config.default_classification_backend`
  * **custom_metrics** (*None*) – an optional list of custom metrics to compute
    or dict mapping metric names to kwargs dicts
  * **progress** (*None*) – whether 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
  * **\*\*kwargs** – optional keyword arguments for the constructor of the
    [`ClassificationEvaluationConfig`](#fiftyone.utils.eval.ClassificationEvaluationConfig) being used
* **Returns:**
  a [`ClassificationResults`](#fiftyone.utils.eval.ClassificationResults)

### *class* fiftyone.utils.eval.ClassificationEvaluationConfig(pred_field, gt_field, custom_metrics=None, \*\*kwargs)

Bases: [`BaseEvaluationMethodConfig`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig)

Base class for configuring `ClassificationEvaluation`
instances.

* **Parameters:**
  * **pred_field** – the name of the field containing the predicted
    [`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification) instances
  * **gt_field** – the name of the field containing the ground truth
    [`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification) instances
  * **custom_metrics** (*None*) – an optional list of custom metrics to compute
    or dict mapping metric names to kwargs dicts

**Attributes:**

| [`type`](#fiftyone.utils.eval.ClassificationEvaluationConfig.type)       | The type of run.                                        |
|--------------------------------------------------------------------------|---------------------------------------------------------|
| [`cls`](#fiftyone.utils.eval.ClassificationEvaluationConfig.cls)         | The fully-qualified name of this `BaseRunConfig` class. |
| [`method`](#fiftyone.utils.eval.ClassificationEvaluationConfig.method)   | The name of the method.                                 |
| [`run_cls`](#fiftyone.utils.eval.ClassificationEvaluationConfig.run_cls) | The `BaseRun` class associated with this config.        |

**Methods:**

| [`attributes`](#fiftyone.utils.eval.ClassificationEvaluationConfig.attributes)()                                                 | Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.utils.eval.ClassificationEvaluationConfig.serialize).   |
|----------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| [`base_config_cls`](#fiftyone.utils.eval.ClassificationEvaluationConfig.base_config_cls)(type)                                   | Returns the config class for the given run type.                                                                                                  |
| [`build`](#fiftyone.utils.eval.ClassificationEvaluationConfig.build)()                                                           | Builds the `BaseRun` instance associated with this config.                                                                                        |
| [`builder`](#fiftyone.utils.eval.ClassificationEvaluationConfig.builder)()                                                       | Returns a ConfigBuilder instance for this class.                                                                                                  |
| [`copy`](#fiftyone.utils.eval.ClassificationEvaluationConfig.copy)()                                                             | Returns a deep copy of the object.                                                                                                                |
| [`custom_attributes`](#fiftyone.utils.eval.ClassificationEvaluationConfig.custom_attributes)([dynamic, private])                 | Returns a customizable list of class attributes.                                                                                                  |
| [`default`](#fiftyone.utils.eval.ClassificationEvaluationConfig.default)()                                                       | Returns the default config instance.                                                                                                              |
| [`from_dict`](#fiftyone.utils.eval.ClassificationEvaluationConfig.from_dict)(d)                                                  | Constructs a `BaseRunConfig` from a serialized JSON dict representation of it.                                                                    |
| [`from_json`](#fiftyone.utils.eval.ClassificationEvaluationConfig.from_json)(path, \*args, \*\*kwargs)                           | Constructs a Serializable object from a JSON file.                                                                                                |
| [`from_kwargs`](#fiftyone.utils.eval.ClassificationEvaluationConfig.from_kwargs)(\*\*kwargs)                                     | Constructs a Config object from keyword arguments.                                                                                                |
| [`from_str`](#fiftyone.utils.eval.ClassificationEvaluationConfig.from_str)(s, \*args, \*\*kwargs)                                | Constructs a Serializable object from a JSON string.                                                                                              |
| [`get_class_name`](#fiftyone.utils.eval.ClassificationEvaluationConfig.get_class_name)()                                         | Returns the fully-qualified class name string of this object.                                                                                     |
| [`load_credentials`](#fiftyone.utils.eval.ClassificationEvaluationConfig.load_credentials)(\*\*kwargs)                           | Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config.                                                 |
| [`load_default`](#fiftyone.utils.eval.ClassificationEvaluationConfig.load_default)()                                             | Loads the default config instance from file.                                                                                                      |
| [`parse_array`](#fiftyone.utils.eval.ClassificationEvaluationConfig.parse_array)(d, key[, default])                              | Parses a raw array attribute.                                                                                                                     |
| [`parse_bool`](#fiftyone.utils.eval.ClassificationEvaluationConfig.parse_bool)(d, key[, default])                                | Parses a boolean value.                                                                                                                           |
| [`parse_categorical`](#fiftyone.utils.eval.ClassificationEvaluationConfig.parse_categorical)(d, key, choices[, default])         | Parses a categorical JSON field, which must take a value from among the given choices.                                                            |
| [`parse_dict`](#fiftyone.utils.eval.ClassificationEvaluationConfig.parse_dict)(d, key[, default])                                | Parses a dictionary attribute.                                                                                                                    |
| [`parse_int`](#fiftyone.utils.eval.ClassificationEvaluationConfig.parse_int)(d, key[, default])                                  | Parses an integer attribute.                                                                                                                      |
| [`parse_mutually_exclusive_fields`](#fiftyone.utils.eval.ClassificationEvaluationConfig.parse_mutually_exclusive_fields)(fields) | Parses a mutually exclusive dictionary of pre-parsed fields, which must contain exactly one field with a truthy value.                            |
| [`parse_number`](#fiftyone.utils.eval.ClassificationEvaluationConfig.parse_number)(d, key[, default])                            | Parses a number attribute.                                                                                                                        |
| [`parse_object`](#fiftyone.utils.eval.ClassificationEvaluationConfig.parse_object)(d, key, cls[, default])                       | Parses an object attribute.                                                                                                                       |
| [`parse_object_array`](#fiftyone.utils.eval.ClassificationEvaluationConfig.parse_object_array)(d, key, cls[, default])           | Parses an array of objects.                                                                                                                       |
| [`parse_object_dict`](#fiftyone.utils.eval.ClassificationEvaluationConfig.parse_object_dict)(d, key, cls[, default])             | Parses a dictionary whose values are objects.                                                                                                     |
| [`parse_path`](#fiftyone.utils.eval.ClassificationEvaluationConfig.parse_path)(d, key[, default])                                | Parses a path attribute.                                                                                                                          |
| [`parse_raw`](#fiftyone.utils.eval.ClassificationEvaluationConfig.parse_raw)(d, key[, default])                                  | Parses a raw (arbitrary) JSON field.                                                                                                              |
| [`parse_string`](#fiftyone.utils.eval.ClassificationEvaluationConfig.parse_string)(d, key[, default])                            | Parses a string attribute.                                                                                                                        |
| [`serialize`](#fiftyone.utils.eval.ClassificationEvaluationConfig.serialize)([reflective])                                       | Serializes the object into a dictionary.                                                                                                          |
| [`to_str`](#fiftyone.utils.eval.ClassificationEvaluationConfig.to_str)([pretty_print])                                           | Returns a string representation of this object.                                                                                                   |
| [`validate_all_or_nothing_fields`](#fiftyone.utils.eval.ClassificationEvaluationConfig.validate_all_or_nothing_fields)(fields)   | Validates a dictionary of pre-parsed fields checking that either all or none of the fields have a truthy value.                                   |
| [`write_json`](#fiftyone.utils.eval.ClassificationEvaluationConfig.write_json)(path[, pretty_print])                             | Serializes the object and writes it to disk.                                                                                                      |

#### *property* type

The type of run.

#### attributes()

Returns the list of class attributes that will be serialized by
[`serialize()`](#fiftyone.utils.eval.ClassificationEvaluationConfig.serialize).

* **Returns:**
  a list of attributes

#### *static* base_config_cls(type)

Returns the config class for the given run type.

* **Parameters:**
  **type** – a `BaseRunConfig.type`
* **Returns:**
  a `BaseRunConfig` subclass

#### build()

Builds the `BaseRun` instance associated with this config.

* **Returns:**
  a `BaseRun` instance

#### *classmethod* builder()

Returns a ConfigBuilder instance for this class.

#### *property* cls

The fully-qualified name of this `BaseRunConfig` class.

#### copy()

Returns a deep copy of the object.

* **Returns:**
  a Serializable instance

#### custom_attributes(dynamic=False, private=False)

Returns a customizable list of class attributes.

By default, all attributes in vars(self) are returned, minus private
attributes (those starting with “_”).

* **Parameters:**
  * **dynamic** – whether to include dynamic properties, e.g., those defined
    by getter/setter methods or the `@property` decorator. By
    default, this is False
  * **private** – whether to include private properties, i.e., those
    starting with “_”. By default, this is False
* **Returns:**
  a list of class attributes

#### *classmethod* default()

Returns the default config instance.

By default, this method instantiates the class from an empty
dictionary, which will only succeed if all attributes are optional.
Otherwise, subclasses should override this method to provide the
desired default configuration.

#### *classmethod* from_dict(d)

Constructs a `BaseRunConfig` from a serialized JSON dict
representation of it.

* **Parameters:**
  **d** – a JSON dict
* **Returns:**
  a `BaseRunConfig`

#### *classmethod* from_json(path, \*args, \*\*kwargs)

Constructs a Serializable object from a JSON file.

Subclasses may override this method, but, by default, this method
simply reads the JSON and calls from_dict(), which subclasses must
implement.

* **Parameters:**
  * **path** – the path to the JSON file on disk
  * **\*args** – optional positional arguments for `self.from_dict()`
  * **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
  an instance of the Serializable class

#### *classmethod* from_kwargs(\*\*kwargs)

Constructs a Config object from keyword arguments.

* **Parameters:**
  **\*\*kwargs** – keyword arguments that define the fields expected by cls
* **Returns:**
  an instance of cls

#### *classmethod* from_str(s, \*args, \*\*kwargs)

Constructs a Serializable object from a JSON string.

Subclasses may override this method, but, by default, this method
simply parses the string and calls from_dict(), which subclasses must
implement.

* **Parameters:**
  * **s** – a JSON string representation of a Serializable object
  * **\*args** – optional positional arguments for `self.from_dict()`
  * **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
  an instance of the Serializable class

#### *classmethod* get_class_name()

Returns the fully-qualified class name string of this object.

#### load_credentials(\*\*kwargs)

Loads any necessary credentials from the given keyword arguments or
the relevant FiftyOne config.

* **Parameters:**
  **\*\*kwargs** – subclass-specific credentials

#### *classmethod* load_default()

Loads the default config instance from file.

Subclasses must implement this method if they intend to support
default instances.

#### *property* method

The name of the method.

#### *static* parse_array(d, key, default=<eta.core.config.NoDefault object>)

Parses a raw array attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default list to return if key is not present
* **Returns:**
  a list of raw (untouched) values
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_bool(d, key, default=<eta.core.config.NoDefault object>)

Parses a boolean value.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default bool to return if key is not present
* **Returns:**
  True/False
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_categorical(d, key, choices, default=<eta.core.config.NoDefault object>)

Parses a categorical JSON field, which must take a value from among
the given choices.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **choices** – either an iterable of possible values or an enum-like
    class whose attributes define the possible values
  * **default** – a default value to return if key is not present
* **Returns:**
  the raw (untouched) value of the given field, which is equal to a
  value from `choices`
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the key was present in the dictionary but its value
      was not an allowed choice, or if no default value was provided
      and the key was not found in the dictionary

#### *static* parse_dict(d, key, default=<eta.core.config.NoDefault object>)

Parses a dictionary attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default dict to return if key is not present
* **Returns:**
  a dictionary
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_int(d, key, default=<eta.core.config.NoDefault object>)

Parses an integer attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default integer value to return if key is not present
* **Returns:**
  an int
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_mutually_exclusive_fields(fields)

Parses a mutually exclusive dictionary of pre-parsed fields, which
must contain exactly one field with a truthy value.

* **Parameters:**
  **fields** – a dictionary of pre-parsed fields
* **Returns:**
  the (field, value) that was set
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if zero or more than one truthy value was found

#### *static* parse_number(d, key, default=<eta.core.config.NoDefault object>)

Parses a number attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default numeric value to return if key is not present
* **Returns:**
  a number (e.g. int, float)
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_object(d, key, cls, default=<eta.core.config.NoDefault object>)

Parses an object attribute.

The value of d[key] can be either an instance of cls or a serialized
dict from an instance of cls.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **cls** – the class of d[key]
  * **default** – a default cls instance to return if key is not present
* **Returns:**
  an instance of cls
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_object_array(d, key, cls, default=<eta.core.config.NoDefault object>)

Parses an array of objects.

The values in d[key] can be either instances of cls or serialized
dicts from instances of cls.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **cls** – the class of the elements of list d[key]
  * **default** – the default list to return if key is not present
* **Returns:**
  a list of cls instances
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_object_dict(d, key, cls, default=<eta.core.config.NoDefault object>)

Parses a dictionary whose values are objects.

The values in d[key] can be either instances of cls or serialized
dicts from instances of cls.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **cls** – the class of the values of dictionary d[key]
  * **default** – the default dict of cls instances to return if key is not
    present
* **Returns:**
  a dictionary whose values are cls instances
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_path(d, key, default=<eta.core.config.NoDefault object>)

Parses a path attribute.

The path is converted to an absolute path if necessary via
`os.path.abspath(os.path.expanduser(value))`.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default string to return if key is not present
* **Returns:**
  a path string
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_raw(d, key, default=<eta.core.config.NoDefault object>)

Parses a raw (arbitrary) JSON field.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default value to return if key is not present
* **Returns:**
  the raw (untouched) value of the given field
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if no default value was provided and the key was not
      found in the dictionary

#### *static* parse_string(d, key, default=<eta.core.config.NoDefault object>)

Parses a string attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default string to return if key is not present
* **Returns:**
  a string
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *property* run_cls

The `BaseRun` class associated with this config.

#### serialize(reflective=False)

Serializes the object into a dictionary.

Serialization is applied recursively to all attributes in the object,
including element-wise serialization of lists and dictionary values.

* **Parameters:**
  **reflective** – whether to include reflective attributes when
  serializing the object. By default, this is False
* **Returns:**
  a JSON dictionary representation of the object

#### to_str(pretty_print=True, \*\*kwargs)

Returns a string representation of this object.

* **Parameters:**
  * **pretty_print** – whether to render the JSON in human readable format
    with newlines and indentations. By default, this is True
  * **\*\*kwargs** – optional keyword arguments for `self.serialize()`
* **Returns:**
  a string representation of the object

#### *static* validate_all_or_nothing_fields(fields)

Validates a dictionary of pre-parsed fields checking that either
all or none of the fields have a truthy value.

* **Parameters:**
  **fields** – a dictionary of pre-parsed fields
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if some values are truth and some are not

#### write_json(path, pretty_print=False, \*\*kwargs)

Serializes the object and writes it to disk.

* **Parameters:**
  * **path** – the output path
  * **pretty_print** – whether to render the JSON in human readable format
    with newlines and indentations. By default, this is False
  * **\*\*kwargs** – optional keyword arguments for `self.serialize()`

### *class* fiftyone.utils.eval.ClassificationResults(samples, config, eval_key, ytrue, ypred, confs=None, weights=None, ytrue_ids=None, ypred_ids=None, classes=None, missing=None, custom_metrics=None, backend=None)

Bases: [`BaseClassificationResults`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults)

Class that stores the results of a classification evaluation.

* **Parameters:**
  * **samples** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) used
  * **config** – the [`ClassificationEvaluationConfig`](#fiftyone.utils.eval.ClassificationEvaluationConfig) used
  * **eval_key** – the evaluation key
  * **ytrue** – a list of ground truth labels
  * **ypred** – a list of predicted labels
  * **confs** (*None*) – an optional list of confidences for the predictions
  * **weights** (*None*) – an optional list of sample weights
  * **ytrue_ids** (*None*) – a list of IDs for the ground truth labels
  * **ypred_ids** (*None*) – a list of IDs for the predicted labels
  * **classes** (*None*) – the list of possible classes. If not provided, the
    observed ground truth/predicted labels are used
  * **missing** (*None*) – a missing label string. Any None-valued labels are
    given this label for evaluation purposes
  * **custom_metrics** (*None*) – an optional dict of custom metrics
  * **backend** (*None*) – a `ClassificationEvaluation` backend

**Methods:**

| [`add_custom_metrics`](#fiftyone.utils.eval.ClassificationResults.add_custom_metrics)(custom_metrics[, overwrite])   | Computes the given custom metrics and adds them to these results.                                                                                                                                                                      |
|----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`attributes`](#fiftyone.utils.eval.ClassificationResults.attributes)()                                              | Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.utils.eval.ClassificationResults.serialize).                                                                                                 |
| [`base_results_cls`](#fiftyone.utils.eval.ClassificationResults.base_results_cls)(type)                              | Returns the results class for the given run type.                                                                                                                                                                                      |
| [`clear_subset`](#fiftyone.utils.eval.ClassificationResults.clear_subset)()                                          | Clears the subset set by [`use_subset()`](#fiftyone.utils.eval.ClassificationResults.use_subset), if any.                                                                                                                              |
| [`confusion_matrix`](#fiftyone.utils.eval.ClassificationResults.confusion_matrix)([classes, include_other, ...])     | Generates a confusion matrix for the results via [`sklearn.metrics.confusion_matrix()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html#sklearn.metrics.confusion_matrix).                     |
| [`copy`](#fiftyone.utils.eval.ClassificationResults.copy)()                                                          | Returns a deep copy of the object.                                                                                                                                                                                                     |
| [`custom_attributes`](#fiftyone.utils.eval.ClassificationResults.custom_attributes)([dynamic, private])              | Returns a customizable list of class attributes.                                                                                                                                                                                       |
| [`from_dict`](#fiftyone.utils.eval.ClassificationResults.from_dict)(d, samples, config, key)                         | Builds a `BaseRunResults` from a JSON dict representation of it.                                                                                                                                                                       |
| [`from_json`](#fiftyone.utils.eval.ClassificationResults.from_json)(path, \*args, \*\*kwargs)                        | Constructs a Serializable object from a JSON file.                                                                                                                                                                                     |
| [`from_str`](#fiftyone.utils.eval.ClassificationResults.from_str)(s, \*args, \*\*kwargs)                             | Constructs a Serializable object from a JSON string.                                                                                                                                                                                   |
| [`get_class_name`](#fiftyone.utils.eval.ClassificationResults.get_class_name)()                                      | Returns the fully-qualified class name string of this object.                                                                                                                                                                          |
| [`get_meta`](#fiftyone.utils.eval.ClassificationResults.get_meta)()                                                  | Small facts that DESCRIBE these results, stored beside the run so callers can read them without loading the results.                                                                                                                   |
| [`metrics`](#fiftyone.utils.eval.ClassificationResults.metrics)([classes, average, beta])                            | Computes classification metrics for the results, including accuracy, precision, recall, and F-beta score.                                                                                                                              |
| [`plot_confusion_matrix`](#fiftyone.utils.eval.ClassificationResults.plot_confusion_matrix)([classes, ...])          | Plots a confusion matrix for the evaluation results.                                                                                                                                                                                   |
| [`print_metrics`](#fiftyone.utils.eval.ClassificationResults.print_metrics)([classes, average, beta, digits])        | Prints the metrics computed via [`metrics()`](#fiftyone.utils.eval.ClassificationResults.metrics).                                                                                                                                     |
| [`print_report`](#fiftyone.utils.eval.ClassificationResults.print_report)([classes, digits])                         | Prints a classification report for the results via [`sklearn.metrics.classification_report()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.classification_report.html#sklearn.metrics.classification_report).    |
| [`report`](#fiftyone.utils.eval.ClassificationResults.report)([classes])                                             | Generates a classification report for the results via [`sklearn.metrics.classification_report()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.classification_report.html#sklearn.metrics.classification_report). |
| [`save`](#fiftyone.utils.eval.ClassificationResults.save)()                                                          | Saves the results to the database.                                                                                                                                                                                                     |
| [`save_config`](#fiftyone.utils.eval.ClassificationResults.save_config)()                                            | Saves these results config to the database.                                                                                                                                                                                            |
| [`serialize`](#fiftyone.utils.eval.ClassificationResults.serialize)([reflective])                                    | Serializes the object into a dictionary.                                                                                                                                                                                               |
| [`to_str`](#fiftyone.utils.eval.ClassificationResults.to_str)([pretty_print])                                        | Returns a string representation of this object.                                                                                                                                                                                        |
| [`use_subset`](#fiftyone.utils.eval.ClassificationResults.use_subset)(subset_def)                                    | Restricts the evaluation results to the specified subset.                                                                                                                                                                              |
| [`write_json`](#fiftyone.utils.eval.ClassificationResults.write_json)(path[, pretty_print])                          | Serializes the object and writes it to disk.                                                                                                                                                                                           |

**Attributes:**

| [`backend`](#fiftyone.utils.eval.ClassificationResults.backend)       | The `BaseRun` for these results.                                                                                                                           |
|-----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`cls`](#fiftyone.utils.eval.ClassificationResults.cls)               | The fully-qualified name of this `BaseRunResults` class.                                                                                                   |
| [`config`](#fiftyone.utils.eval.ClassificationResults.config)         | The `BaseRunConfig` for these results.                                                                                                                     |
| [`has_subset`](#fiftyone.utils.eval.ClassificationResults.has_subset) | Whether these results are currently restricted to a subset via [`use_subset()`](#fiftyone.utils.eval.ClassificationResults.use_subset).                    |
| [`key`](#fiftyone.utils.eval.ClassificationResults.key)               | The run key for these results.                                                                                                                             |
| [`samples`](#fiftyone.utils.eval.ClassificationResults.samples)       | The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) associated with these results. |

#### add_custom_metrics(custom_metrics, overwrite=True)

Computes the given custom metrics and adds them to these results.

* **Parameters:**
  * **custom_metrics** – a list of custom metrics to compute or a dict
    mapping metric names to kwargs dicts
  * **overwrite** (*True*) – whether to recompute any custom metrics that
    have already been applied

#### attributes()

Returns the list of class attributes that will be serialized by
[`serialize()`](#fiftyone.utils.eval.ClassificationResults.serialize).

* **Returns:**
  a list of attributes

#### *property* backend

The `BaseRun` for these results.

#### *static* base_results_cls(type)

Returns the results class for the given run type.

* **Parameters:**
  **type** – a `BaseRunConfig.type`
* **Returns:**
  a `BaseRunResults` subclass

#### clear_subset()

Clears the subset set by [`use_subset()`](#fiftyone.utils.eval.ClassificationResults.use_subset), if any.

Subsequent operations will be performed on the full results.

#### *property* cls

The fully-qualified name of this `BaseRunResults` class.

#### *property* config

The `BaseRunConfig` for these results.

#### confusion_matrix(classes=None, include_other=False, include_missing=False)

Generates a confusion matrix for the results via
[`sklearn.metrics.confusion_matrix()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html#sklearn.metrics.confusion_matrix).

The rows of the confusion matrix represent ground truth and the columns
represent predictions.

* **Parameters:**
  * **classes** (*None*) – an optional list of classes to include in the
    confusion matrix
  * **include_other** (*False*) – whether to include an extra row/column at
    the end of the matrix for labels that do not appear in
    `classes`. Only applicable if `classes` are provided
  * **include_missing** (*False*) – whether to include a row/column at the end
    of the matrix for unmatched labels. Only applicable if
    `self.missing` does not already appear in `classes`. If
    both “other” and “missing” rows/columns are requested, this one
    is last
* **Returns:**
  a `num_classes x num_classes` confusion matrix

#### copy()

Returns a deep copy of the object.

* **Returns:**
  a Serializable instance

#### custom_attributes(dynamic=False, private=False)

Returns a customizable list of class attributes.

By default, all attributes in vars(self) are returned, minus private
attributes (those starting with “_”).

* **Parameters:**
  * **dynamic** – whether to include dynamic properties, e.g., those defined
    by getter/setter methods or the `@property` decorator. By
    default, this is False
  * **private** – whether to include private properties, i.e., those
    starting with “_”. By default, this is False
* **Returns:**
  a list of class attributes

#### *classmethod* from_dict(d, samples, config, key)

Builds a `BaseRunResults` from a JSON dict representation of
it.

* **Parameters:**
  * **d** – a JSON dict
  * **samples** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
    for the run
  * **config** – the `BaseRunConfig` for the run
  * **key** – the run key
* **Returns:**
  a `BaseRunResults`

#### *classmethod* from_json(path, \*args, \*\*kwargs)

Constructs a Serializable object from a JSON file.

Subclasses may override this method, but, by default, this method
simply reads the JSON and calls from_dict(), which subclasses must
implement.

* **Parameters:**
  * **path** – the path to the JSON file on disk
  * **\*args** – optional positional arguments for `self.from_dict()`
  * **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
  an instance of the Serializable class

#### *classmethod* from_str(s, \*args, \*\*kwargs)

Constructs a Serializable object from a JSON string.

Subclasses may override this method, but, by default, this method
simply parses the string and calls from_dict(), which subclasses must
implement.

* **Parameters:**
  * **s** – a JSON string representation of a Serializable object
  * **\*args** – optional positional arguments for `self.from_dict()`
  * **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
  an instance of the Serializable class

#### *classmethod* get_class_name()

Returns the fully-qualified class name string of this object.

#### get_meta()

Small facts that DESCRIBE these results, stored beside the run so
callers can read them without loading the results.

The results themselves are a blob in GridFS whose arrays can run to
hundreds of MB; a count or a path is a few bytes. Anything returned
here is written when the results are saved (see
`BaseRun.save_run_results()`), so no read path has to load — or
write — to answer for it.

* **Returns:**
  a JSON-serializable dict

#### *property* has_subset

Whether these results are currently restricted to a subset via
[`use_subset()`](#fiftyone.utils.eval.ClassificationResults.use_subset).

#### *property* key

The run key for these results.

#### metrics(classes=None, average='micro', beta=1.0)

Computes classification metrics for the results, including accuracy,
precision, recall, and F-beta score.

See [`sklearn.metrics.precision_recall_fscore_support()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.precision_recall_fscore_support.html#sklearn.metrics.precision_recall_fscore_support) for
details.

Also includes any custom metrics from `custom_metrics`.

* **Parameters:**
  * **classes** (*None*) – an optional list of classes to include in the
    calculations
  * **average** ( *"micro"*) – the averaging strategy to use
  * **beta** (*1.0*) – the F-beta value to use
* **Returns:**
  a dict

#### plot_confusion_matrix(classes=None, include_other=None, include_missing=None, other_label='(other)', backend='plotly', \*\*kwargs)

Plots a confusion matrix for the evaluation results.

If you are working in a notebook environment with the default plotly
backend, this method returns an interactive
[`fiftyone.core.plots.plotly.InteractiveHeatmap`](fiftyone.core.plots.plotly.md#fiftyone.core.plots.plotly.InteractiveHeatmap) that you can
attach to an App session via its
[`fiftyone.core.session.Session.plots`](fiftyone.core.session.md#fiftyone.core.session.Session.plots) attribute, which will
automatically sync the session’s view with the currently selected cells
in the confusion matrix.

* **Parameters:**
  * **classes** (*None*) – an optional list of classes to include in the
    confusion matrix
  * **include_other** (*None*) – 

    whether to include a row/column for examples
    whose label is in `classes` but are matched to labels that
    do not appear in `classes`. Only applicable if `classes`
    are provided. The supported values are:
    - None (default): only include a row/column for other labels
      if there are any
    - True: do include a row/column for other labels
    - False: do not include a row/column for other labels
  * **include_missing** (*None*) – 

    whether to include a row/column for missing
    ground truth/predictions in the confusion matrix. The supported
    values are:
    - None (default): only include a row/column for missing
      labels if there are any
    - True: do include a row/column for missing labels
    - False: do not include a row/column for missing labels
  * **other_label** ( *"* *(**other* *)* *"*) – the label to use for “other” predictions
  * **backend** ( *"plotly"*) – the plotting backend to use. Supported values
    are `("plotly", "matplotlib")`
  * **\*\*kwargs** – 

    keyword arguments for the backend plotting method:
    - ”plotly” backend: [`fiftyone.core.plots.plotly.plot_confusion_matrix()`](fiftyone.core.plots.plotly.md#fiftyone.core.plots.plotly.plot_confusion_matrix)
    - ”matplotlib” backend: [`fiftyone.core.plots.matplotlib.plot_confusion_matrix()`](fiftyone.core.plots.matplotlib.md#fiftyone.core.plots.matplotlib.plot_confusion_matrix)
* **Returns:**
  - a [`fiftyone.core.plots.plotly.InteractiveHeatmap`](fiftyone.core.plots.plotly.md#fiftyone.core.plots.plotly.InteractiveHeatmap), if
    the plotly backend is used
  - a matplotlib figure, otherwise
* **Return type:**
  one of the following

#### print_metrics(classes=None, average='micro', beta=1.0, digits=2)

Prints the metrics computed via [`metrics()`](#fiftyone.utils.eval.ClassificationResults.metrics).

* **Parameters:**
  * **classes** (*None*) – an optional list of classes to include in the
    calculations
  * **average** ( *"micro"*) – the averaging strategy to use
  * **beta** (*1.0*) – the F-beta value to use
  * **digits** (*2*) – the number of digits of precision to print

#### print_report(classes=None, digits=2)

Prints a classification report for the results via
[`sklearn.metrics.classification_report()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.classification_report.html#sklearn.metrics.classification_report).

* **Parameters:**
  * **classes** (*None*) – an optional list of classes to include in the
    report
  * **digits** (*2*) – the number of digits of precision to print

#### report(classes=None)

Generates a classification report for the results via
[`sklearn.metrics.classification_report()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.classification_report.html#sklearn.metrics.classification_report).

* **Parameters:**
  **classes** (*None*) – an optional list of classes to include in the
  report
* **Returns:**
  a dict

#### *property* samples

The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) associated
with these results.

#### save()

Saves the results to the database.

#### save_config()

Saves these results config to the database.

#### serialize(reflective=False)

Serializes the object into a dictionary.

Serialization is applied recursively to all attributes in the object,
including element-wise serialization of lists and dictionary values.

* **Parameters:**
  **reflective** – whether to include reflective attributes when
  serializing the object. By default, this is False
* **Returns:**
  a JSON dictionary representation of the object

#### to_str(pretty_print=True, \*\*kwargs)

Returns a string representation of this object.

* **Parameters:**
  * **pretty_print** – whether to render the JSON in human readable format
    with newlines and indentations. By default, this is True
  * **\*\*kwargs** – optional keyword arguments for `self.serialize()`
* **Returns:**
  a string representation of the object

#### use_subset(subset_def)

Restricts the evaluation results to the specified subset.

Subsequent calls to supported methods on this instance will only
contain results from the specified subset rather than the full results.

Use [`clear_subset()`](#fiftyone.utils.eval.ClassificationResults.clear_subset) to reset to the full results. Or,
equivalently, use the context manager interface as demonstrated below
to automatically reset the results when the context exits.

Example usage:

```default
import fiftyone as fo
import fiftyone.zoo as foz
import fiftyone.utils.random as four
from fiftyone import ViewField as F

dataset = foz.load_zoo_dataset("quickstart")
four.random_split(dataset, {"sunny": 0.7, "cloudy": 0.2, "rainy": 0.1})

results = dataset.evaluate_detections(
    "predictions",
    gt_field="ground_truth",
    eval_key="eval",
)

counts = dataset.count_values("ground_truth.detections.label")
classes = sorted(counts, key=counts.get, reverse=True)[:5]

# Full results
results.print_report(classes=classes)

# Sunny samples
subset_def = dict(type="field", field="tags", value="sunny")
with results.use_subset(subset_def):
    results.print_report(classes=classes)

# Small objects
bbox_area = F("bounding_box")[2] * F("bounding_box")[3]
small_objects = bbox_area <= 0.05
subset_def = dict(type="attribute", expr=small_objects)
with results.use_subset(subset_def):
    results.print_report(classes=classes)
```

* **Parameters:**
  **subset_def** – 

  the subset definition, which can be:
  - a dict or list of dicts defining the subset. See above
    for examples and see [`get_subset_view()`](#fiftyone.utils.eval.get_subset_view) for full
    syntax
  - a [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView) defining the
    subset
* **Returns:**
  self

#### write_json(path, pretty_print=False, \*\*kwargs)

Serializes the object and writes it to disk.

* **Parameters:**
  * **path** – the output path
  * **pretty_print** – whether to render the JSON in human readable format
    with newlines and indentations. By default, this is False
  * **\*\*kwargs** – optional keyword arguments for `self.serialize()`

### fiftyone.utils.eval.evaluate_detections(samples, pred_field, gt_field='ground_truth', eval_key=None, classes=None, missing=None, method=None, iou=0.5, use_masks=False, use_boxes=False, classwise=True, dynamic=True, custom_metrics=None, progress=None, \*\*kwargs)

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

This method supports evaluating the following spatial data types:

- Object detections in [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections) format
- Instance segmentations in [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections)
  format with their `mask` attributes populated
- Polygons in [`fiftyone.core.labels.Polylines`](fiftyone.core.labels.md#fiftyone.core.labels.Polylines) format
- Keypoints in [`fiftyone.core.labels.Keypoints`](fiftyone.core.labels.md#fiftyone.core.labels.Keypoints) format
- Temporal detections in [`fiftyone.core.labels.TemporalDetections`](fiftyone.core.labels.md#fiftyone.core.labels.TemporalDetections)
  format

For spatial object detection evaluation, this method uses COCO-style
evaluation by default.

When evaluating keypoints, “IoUs” are computed via
[object keypoint similarity](https://cocodataset.org/#keypoints-eval).
You can pass `keypoint_sigmas` to customize the per-keypoint OKS falloff.

For temporal segment detection, this method uses ActivityNet-style
evaluation by default.

You can use the `method` parameter to select a different method, and you
can optionally customize the method by passing additional parameters for
the method’s config class as `kwargs`.

The natively provided `method` values and their associated configs are:

- `"coco"`: [`fiftyone.utils.eval.coco.COCOEvaluationConfig`](fiftyone.utils.eval.coco.md#fiftyone.utils.eval.coco.COCOEvaluationConfig)
- `"open-images"`: [`fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig`](fiftyone.utils.eval.openimages.md#fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig)
- `"activitynet"`: [`fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig`](fiftyone.utils.eval.activitynet.md#fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig)

If an `eval_key` is provided, a number of fields are populated at the
object- and sample-level recording the results of the evaluation:

- True positive (TP), false positive (FP), and false negative (FN) counts
  for each sample are saved in top-level fields of each sample:
  ```default
  TP: sample.<eval_key>_tp
  FP: sample.<eval_key>_fp
  FN: sample.<eval_key>_fn
  ```

  In addition, when evaluating frame-level objects, TP/FP/FN counts are
  recorded for each frame:
  ```default
  TP: frame.<eval_key>_tp
  FP: frame.<eval_key>_fp
  FN: frame.<eval_key>_fn
  ```
- The fields listed below are populated on each individual object; these
  fields tabulate the TP/FP/FN status of the object, the ID of the
  matching object (if any), and the matching IoU:
  ```default
  TP/FP/FN: object.<eval_key>
        ID: object.<eval_key>_id
       IoU: object.<eval_key>_iou
  ```

* **Parameters:**
  * **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
  * **pred_field** – the name of the field containing the predicted
    [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections),
    [`fiftyone.core.labels.Polylines`](fiftyone.core.labels.md#fiftyone.core.labels.Polylines),
    [`fiftyone.core.labels.Keypoints`](fiftyone.core.labels.md#fiftyone.core.labels.Keypoints),
    or [`fiftyone.core.labels.TemporalDetections`](fiftyone.core.labels.md#fiftyone.core.labels.TemporalDetections)
  * **gt_field** ( *"ground_truth"*) – the name of the field containing the ground
    truth [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections),
    [`fiftyone.core.labels.Polylines`](fiftyone.core.labels.md#fiftyone.core.labels.Polylines),
    [`fiftyone.core.labels.Keypoints`](fiftyone.core.labels.md#fiftyone.core.labels.Keypoints),
    or [`fiftyone.core.labels.TemporalDetections`](fiftyone.core.labels.md#fiftyone.core.labels.TemporalDetections)
  * **eval_key** (*None*) – an evaluation key to use to refer to this evaluation
  * **classes** (*None*) – the list of possible classes. If not provided, the
    observed ground truth/predicted labels are used
  * **missing** (*None*) – a missing label string. Any unmatched objects are given
    this label for results purposes
  * **method** (*None*) – a string specifying the evaluation method to use. The
    supported values are
    `fo.evaluation_config.detection_backends.keys()` and the default
    is `fo.evaluation_config.default_detection_backend`
  * **iou** (*0.50*) – the IoU threshold to use to determine matches
  * **use_masks** (*False*) – whether to compute IoUs using the instances masks in
    the `mask` attribute of the provided objects, which must be
    [`fiftyone.core.labels.Detection`](fiftyone.core.labels.md#fiftyone.core.labels.Detection) instances
  * **use_boxes** (*False*) – whether to compute IoUs using the bounding boxes
    of the provided [`fiftyone.core.labels.Polyline`](fiftyone.core.labels.md#fiftyone.core.labels.Polyline) instances
    rather than using their actual geometries
  * **classwise** (*True*) – whether to only match objects with the same class
    label (True) or allow matches between classes (False)
  * **dynamic** (*True*) – whether to declare the dynamic object-level attributes
    that are populated on the dataset’s schema
  * **custom_metrics** (*None*) – an optional list of custom metrics to compute
    or dict mapping metric names to kwargs dicts
  * **progress** (*None*) – whether 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
  * **\*\*kwargs** – optional keyword arguments for the constructor of the
    [`DetectionEvaluationConfig`](#fiftyone.utils.eval.DetectionEvaluationConfig) being used
* **Returns:**
  a [`DetectionResults`](#fiftyone.utils.eval.DetectionResults)

### *class* fiftyone.utils.eval.DetectionEvaluationConfig(pred_field, gt_field, iou=None, classwise=None, custom_metrics=None, \*\*kwargs)

Bases: [`BaseEvaluationMethodConfig`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig)

Base class for configuring `DetectionEvaluation` instances.

* **Parameters:**
  * **pred_field** – the name of the field containing the predicted
    [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections),
    [`fiftyone.core.labels.Polylines`](fiftyone.core.labels.md#fiftyone.core.labels.Polylines), or
    [`fiftyone.core.labels.Keypoints`](fiftyone.core.labels.md#fiftyone.core.labels.Keypoints)
  * **gt_field** – the name of the field containing the ground truth
    [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections),
    [`fiftyone.core.labels.Polylines`](fiftyone.core.labels.md#fiftyone.core.labels.Polylines), or
    [`fiftyone.core.labels.Keypoints`](fiftyone.core.labels.md#fiftyone.core.labels.Keypoints)
  * **iou** (*None*) – the IoU threshold to use to determine matches
  * **classwise** (*None*) – whether to only match objects with the same class
    label (True) or allow matches between classes (False)
  * **custom_metrics** (*None*) – an optional list of custom metrics to compute
    or dict mapping metric names to kwargs dicts

**Attributes:**

| [`type`](#fiftyone.utils.eval.DetectionEvaluationConfig.type)                                             | The type of run.                                                                                |
|-----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|
| [`requires_additional_fields`](#fiftyone.utils.eval.DetectionEvaluationConfig.requires_additional_fields) | Whether fields besides `pred_field` and `gt_field` are required in order to perform evaluation. |
| [`cls`](#fiftyone.utils.eval.DetectionEvaluationConfig.cls)                                               | The fully-qualified name of this `BaseRunConfig` class.                                         |
| [`method`](#fiftyone.utils.eval.DetectionEvaluationConfig.method)                                         | The name of the method.                                                                         |
| [`run_cls`](#fiftyone.utils.eval.DetectionEvaluationConfig.run_cls)                                       | The `BaseRun` class associated with this config.                                                |

**Methods:**

| [`attributes`](#fiftyone.utils.eval.DetectionEvaluationConfig.attributes)()                                                 | Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.utils.eval.DetectionEvaluationConfig.serialize).   |
|-----------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
| [`base_config_cls`](#fiftyone.utils.eval.DetectionEvaluationConfig.base_config_cls)(type)                                   | Returns the config class for the given run type.                                                                                             |
| [`build`](#fiftyone.utils.eval.DetectionEvaluationConfig.build)()                                                           | Builds the `BaseRun` instance associated with this config.                                                                                   |
| [`builder`](#fiftyone.utils.eval.DetectionEvaluationConfig.builder)()                                                       | Returns a ConfigBuilder instance for this class.                                                                                             |
| [`copy`](#fiftyone.utils.eval.DetectionEvaluationConfig.copy)()                                                             | Returns a deep copy of the object.                                                                                                           |
| [`custom_attributes`](#fiftyone.utils.eval.DetectionEvaluationConfig.custom_attributes)([dynamic, private])                 | Returns a customizable list of class attributes.                                                                                             |
| [`default`](#fiftyone.utils.eval.DetectionEvaluationConfig.default)()                                                       | Returns the default config instance.                                                                                                         |
| [`from_dict`](#fiftyone.utils.eval.DetectionEvaluationConfig.from_dict)(d)                                                  | Constructs a `BaseRunConfig` from a serialized JSON dict representation of it.                                                               |
| [`from_json`](#fiftyone.utils.eval.DetectionEvaluationConfig.from_json)(path, \*args, \*\*kwargs)                           | Constructs a Serializable object from a JSON file.                                                                                           |
| [`from_kwargs`](#fiftyone.utils.eval.DetectionEvaluationConfig.from_kwargs)(\*\*kwargs)                                     | Constructs a Config object from keyword arguments.                                                                                           |
| [`from_str`](#fiftyone.utils.eval.DetectionEvaluationConfig.from_str)(s, \*args, \*\*kwargs)                                | Constructs a Serializable object from a JSON string.                                                                                         |
| [`get_class_name`](#fiftyone.utils.eval.DetectionEvaluationConfig.get_class_name)()                                         | Returns the fully-qualified class name string of this object.                                                                                |
| [`load_credentials`](#fiftyone.utils.eval.DetectionEvaluationConfig.load_credentials)(\*\*kwargs)                           | Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config.                                            |
| [`load_default`](#fiftyone.utils.eval.DetectionEvaluationConfig.load_default)()                                             | Loads the default config instance from file.                                                                                                 |
| [`parse_array`](#fiftyone.utils.eval.DetectionEvaluationConfig.parse_array)(d, key[, default])                              | Parses a raw array attribute.                                                                                                                |
| [`parse_bool`](#fiftyone.utils.eval.DetectionEvaluationConfig.parse_bool)(d, key[, default])                                | Parses a boolean value.                                                                                                                      |
| [`parse_categorical`](#fiftyone.utils.eval.DetectionEvaluationConfig.parse_categorical)(d, key, choices[, default])         | Parses a categorical JSON field, which must take a value from among the given choices.                                                       |
| [`parse_dict`](#fiftyone.utils.eval.DetectionEvaluationConfig.parse_dict)(d, key[, default])                                | Parses a dictionary attribute.                                                                                                               |
| [`parse_int`](#fiftyone.utils.eval.DetectionEvaluationConfig.parse_int)(d, key[, default])                                  | Parses an integer attribute.                                                                                                                 |
| [`parse_mutually_exclusive_fields`](#fiftyone.utils.eval.DetectionEvaluationConfig.parse_mutually_exclusive_fields)(fields) | Parses a mutually exclusive dictionary of pre-parsed fields, which must contain exactly one field with a truthy value.                       |
| [`parse_number`](#fiftyone.utils.eval.DetectionEvaluationConfig.parse_number)(d, key[, default])                            | Parses a number attribute.                                                                                                                   |
| [`parse_object`](#fiftyone.utils.eval.DetectionEvaluationConfig.parse_object)(d, key, cls[, default])                       | Parses an object attribute.                                                                                                                  |
| [`parse_object_array`](#fiftyone.utils.eval.DetectionEvaluationConfig.parse_object_array)(d, key, cls[, default])           | Parses an array of objects.                                                                                                                  |
| [`parse_object_dict`](#fiftyone.utils.eval.DetectionEvaluationConfig.parse_object_dict)(d, key, cls[, default])             | Parses a dictionary whose values are objects.                                                                                                |
| [`parse_path`](#fiftyone.utils.eval.DetectionEvaluationConfig.parse_path)(d, key[, default])                                | Parses a path attribute.                                                                                                                     |
| [`parse_raw`](#fiftyone.utils.eval.DetectionEvaluationConfig.parse_raw)(d, key[, default])                                  | Parses a raw (arbitrary) JSON field.                                                                                                         |
| [`parse_string`](#fiftyone.utils.eval.DetectionEvaluationConfig.parse_string)(d, key[, default])                            | Parses a string attribute.                                                                                                                   |
| [`serialize`](#fiftyone.utils.eval.DetectionEvaluationConfig.serialize)([reflective])                                       | Serializes the object into a dictionary.                                                                                                     |
| [`to_str`](#fiftyone.utils.eval.DetectionEvaluationConfig.to_str)([pretty_print])                                           | Returns a string representation of this object.                                                                                              |
| [`validate_all_or_nothing_fields`](#fiftyone.utils.eval.DetectionEvaluationConfig.validate_all_or_nothing_fields)(fields)   | Validates a dictionary of pre-parsed fields checking that either all or none of the fields have a truthy value.                              |
| [`write_json`](#fiftyone.utils.eval.DetectionEvaluationConfig.write_json)(path[, pretty_print])                             | Serializes the object and writes it to disk.                                                                                                 |

#### *property* type

The type of run.

#### *property* requires_additional_fields

Whether fields besides `pred_field` and `gt_field` are required
in order to perform evaluation.

If True then the entire samples will be loaded rather than using
[`select_fields()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.select_fields)
to optimize.

#### attributes()

Returns the list of class attributes that will be serialized by
[`serialize()`](#fiftyone.utils.eval.DetectionEvaluationConfig.serialize).

* **Returns:**
  a list of attributes

#### *static* base_config_cls(type)

Returns the config class for the given run type.

* **Parameters:**
  **type** – a `BaseRunConfig.type`
* **Returns:**
  a `BaseRunConfig` subclass

#### build()

Builds the `BaseRun` instance associated with this config.

* **Returns:**
  a `BaseRun` instance

#### *classmethod* builder()

Returns a ConfigBuilder instance for this class.

#### *property* cls

The fully-qualified name of this `BaseRunConfig` class.

#### copy()

Returns a deep copy of the object.

* **Returns:**
  a Serializable instance

#### custom_attributes(dynamic=False, private=False)

Returns a customizable list of class attributes.

By default, all attributes in vars(self) are returned, minus private
attributes (those starting with “_”).

* **Parameters:**
  * **dynamic** – whether to include dynamic properties, e.g., those defined
    by getter/setter methods or the `@property` decorator. By
    default, this is False
  * **private** – whether to include private properties, i.e., those
    starting with “_”. By default, this is False
* **Returns:**
  a list of class attributes

#### *classmethod* default()

Returns the default config instance.

By default, this method instantiates the class from an empty
dictionary, which will only succeed if all attributes are optional.
Otherwise, subclasses should override this method to provide the
desired default configuration.

#### *classmethod* from_dict(d)

Constructs a `BaseRunConfig` from a serialized JSON dict
representation of it.

* **Parameters:**
  **d** – a JSON dict
* **Returns:**
  a `BaseRunConfig`

#### *classmethod* from_json(path, \*args, \*\*kwargs)

Constructs a Serializable object from a JSON file.

Subclasses may override this method, but, by default, this method
simply reads the JSON and calls from_dict(), which subclasses must
implement.

* **Parameters:**
  * **path** – the path to the JSON file on disk
  * **\*args** – optional positional arguments for `self.from_dict()`
  * **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
  an instance of the Serializable class

#### *classmethod* from_kwargs(\*\*kwargs)

Constructs a Config object from keyword arguments.

* **Parameters:**
  **\*\*kwargs** – keyword arguments that define the fields expected by cls
* **Returns:**
  an instance of cls

#### *classmethod* from_str(s, \*args, \*\*kwargs)

Constructs a Serializable object from a JSON string.

Subclasses may override this method, but, by default, this method
simply parses the string and calls from_dict(), which subclasses must
implement.

* **Parameters:**
  * **s** – a JSON string representation of a Serializable object
  * **\*args** – optional positional arguments for `self.from_dict()`
  * **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
  an instance of the Serializable class

#### *classmethod* get_class_name()

Returns the fully-qualified class name string of this object.

#### load_credentials(\*\*kwargs)

Loads any necessary credentials from the given keyword arguments or
the relevant FiftyOne config.

* **Parameters:**
  **\*\*kwargs** – subclass-specific credentials

#### *classmethod* load_default()

Loads the default config instance from file.

Subclasses must implement this method if they intend to support
default instances.

#### *property* method

The name of the method.

#### *static* parse_array(d, key, default=<eta.core.config.NoDefault object>)

Parses a raw array attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default list to return if key is not present
* **Returns:**
  a list of raw (untouched) values
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_bool(d, key, default=<eta.core.config.NoDefault object>)

Parses a boolean value.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default bool to return if key is not present
* **Returns:**
  True/False
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_categorical(d, key, choices, default=<eta.core.config.NoDefault object>)

Parses a categorical JSON field, which must take a value from among
the given choices.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **choices** – either an iterable of possible values or an enum-like
    class whose attributes define the possible values
  * **default** – a default value to return if key is not present
* **Returns:**
  the raw (untouched) value of the given field, which is equal to a
  value from `choices`
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the key was present in the dictionary but its value
      was not an allowed choice, or if no default value was provided
      and the key was not found in the dictionary

#### *static* parse_dict(d, key, default=<eta.core.config.NoDefault object>)

Parses a dictionary attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default dict to return if key is not present
* **Returns:**
  a dictionary
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_int(d, key, default=<eta.core.config.NoDefault object>)

Parses an integer attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default integer value to return if key is not present
* **Returns:**
  an int
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_mutually_exclusive_fields(fields)

Parses a mutually exclusive dictionary of pre-parsed fields, which
must contain exactly one field with a truthy value.

* **Parameters:**
  **fields** – a dictionary of pre-parsed fields
* **Returns:**
  the (field, value) that was set
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if zero or more than one truthy value was found

#### *static* parse_number(d, key, default=<eta.core.config.NoDefault object>)

Parses a number attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default numeric value to return if key is not present
* **Returns:**
  a number (e.g. int, float)
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_object(d, key, cls, default=<eta.core.config.NoDefault object>)

Parses an object attribute.

The value of d[key] can be either an instance of cls or a serialized
dict from an instance of cls.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **cls** – the class of d[key]
  * **default** – a default cls instance to return if key is not present
* **Returns:**
  an instance of cls
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_object_array(d, key, cls, default=<eta.core.config.NoDefault object>)

Parses an array of objects.

The values in d[key] can be either instances of cls or serialized
dicts from instances of cls.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **cls** – the class of the elements of list d[key]
  * **default** – the default list to return if key is not present
* **Returns:**
  a list of cls instances
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_object_dict(d, key, cls, default=<eta.core.config.NoDefault object>)

Parses a dictionary whose values are objects.

The values in d[key] can be either instances of cls or serialized
dicts from instances of cls.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **cls** – the class of the values of dictionary d[key]
  * **default** – the default dict of cls instances to return if key is not
    present
* **Returns:**
  a dictionary whose values are cls instances
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_path(d, key, default=<eta.core.config.NoDefault object>)

Parses a path attribute.

The path is converted to an absolute path if necessary via
`os.path.abspath(os.path.expanduser(value))`.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default string to return if key is not present
* **Returns:**
  a path string
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_raw(d, key, default=<eta.core.config.NoDefault object>)

Parses a raw (arbitrary) JSON field.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default value to return if key is not present
* **Returns:**
  the raw (untouched) value of the given field
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if no default value was provided and the key was not
      found in the dictionary

#### *static* parse_string(d, key, default=<eta.core.config.NoDefault object>)

Parses a string attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default string to return if key is not present
* **Returns:**
  a string
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *property* run_cls

The `BaseRun` class associated with this config.

#### serialize(reflective=False)

Serializes the object into a dictionary.

Serialization is applied recursively to all attributes in the object,
including element-wise serialization of lists and dictionary values.

* **Parameters:**
  **reflective** – whether to include reflective attributes when
  serializing the object. By default, this is False
* **Returns:**
  a JSON dictionary representation of the object

#### to_str(pretty_print=True, \*\*kwargs)

Returns a string representation of this object.

* **Parameters:**
  * **pretty_print** – whether to render the JSON in human readable format
    with newlines and indentations. By default, this is True
  * **\*\*kwargs** – optional keyword arguments for `self.serialize()`
* **Returns:**
  a string representation of the object

#### *static* validate_all_or_nothing_fields(fields)

Validates a dictionary of pre-parsed fields checking that either
all or none of the fields have a truthy value.

* **Parameters:**
  **fields** – a dictionary of pre-parsed fields
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if some values are truth and some are not

#### write_json(path, pretty_print=False, \*\*kwargs)

Serializes the object and writes it to disk.

* **Parameters:**
  * **path** – the output path
  * **pretty_print** – whether to render the JSON in human readable format
    with newlines and indentations. By default, this is False
  * **\*\*kwargs** – optional keyword arguments for `self.serialize()`

### *class* fiftyone.utils.eval.DetectionResults(samples, config, eval_key, matches, classes=None, missing=None, custom_metrics=None, backend=None)

Bases: [`BaseClassificationResults`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults)

Class that stores the results of a detection evaluation.

* **Parameters:**
  * **samples** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) used
  * **config** – the [`DetectionEvaluationConfig`](#fiftyone.utils.eval.DetectionEvaluationConfig) used
  * **eval_key** – the evaluation key
  * **matches** – a list of
    `(gt_label, pred_label, iou, pred_confidence, gt_id, pred_id)`
    matches. Either label can be `None` to indicate an unmatched
    object
  * **classes** (*None*) – the list of possible classes. If not provided, the
    observed ground truth/predicted labels are used
  * **missing** (*None*) – a missing label string. Any unmatched objects are given
    this label for evaluation purposes
  * **custom_metrics** (*None*) – an optional dict of custom metrics
  * **backend** (*None*) – a `DetectionEvaluation` backend

**Methods:**

| [`add_custom_metrics`](#fiftyone.utils.eval.DetectionResults.add_custom_metrics)(custom_metrics[, overwrite])   | Computes the given custom metrics and adds them to these results.                                                                                                                                                                      |
|-----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`attributes`](#fiftyone.utils.eval.DetectionResults.attributes)()                                              | Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.utils.eval.DetectionResults.serialize).                                                                                                      |
| [`base_results_cls`](#fiftyone.utils.eval.DetectionResults.base_results_cls)(type)                              | Returns the results class for the given run type.                                                                                                                                                                                      |
| [`clear_subset`](#fiftyone.utils.eval.DetectionResults.clear_subset)()                                          | Clears the subset set by [`use_subset()`](#fiftyone.utils.eval.DetectionResults.use_subset), if any.                                                                                                                                   |
| [`confusion_matrix`](#fiftyone.utils.eval.DetectionResults.confusion_matrix)([classes, include_other, ...])     | Generates a confusion matrix for the results via [`sklearn.metrics.confusion_matrix()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html#sklearn.metrics.confusion_matrix).                     |
| [`copy`](#fiftyone.utils.eval.DetectionResults.copy)()                                                          | Returns a deep copy of the object.                                                                                                                                                                                                     |
| [`custom_attributes`](#fiftyone.utils.eval.DetectionResults.custom_attributes)([dynamic, private])              | Returns a customizable list of class attributes.                                                                                                                                                                                       |
| [`from_dict`](#fiftyone.utils.eval.DetectionResults.from_dict)(d, samples, config, key)                         | Builds a `BaseRunResults` from a JSON dict representation of it.                                                                                                                                                                       |
| [`from_json`](#fiftyone.utils.eval.DetectionResults.from_json)(path, \*args, \*\*kwargs)                        | Constructs a Serializable object from a JSON file.                                                                                                                                                                                     |
| [`from_str`](#fiftyone.utils.eval.DetectionResults.from_str)(s, \*args, \*\*kwargs)                             | Constructs a Serializable object from a JSON string.                                                                                                                                                                                   |
| [`get_class_name`](#fiftyone.utils.eval.DetectionResults.get_class_name)()                                      | Returns the fully-qualified class name string of this object.                                                                                                                                                                          |
| [`get_meta`](#fiftyone.utils.eval.DetectionResults.get_meta)()                                                  | Small facts that DESCRIBE these results, stored beside the run so callers can read them without loading the results.                                                                                                                   |
| [`metrics`](#fiftyone.utils.eval.DetectionResults.metrics)([classes, average, beta])                            | Computes classification metrics for the results, including accuracy, precision, recall, and F-beta score.                                                                                                                              |
| [`plot_confusion_matrix`](#fiftyone.utils.eval.DetectionResults.plot_confusion_matrix)([classes, ...])          | Plots a confusion matrix for the evaluation results.                                                                                                                                                                                   |
| [`print_metrics`](#fiftyone.utils.eval.DetectionResults.print_metrics)([classes, average, beta, digits])        | Prints the metrics computed via [`metrics()`](#fiftyone.utils.eval.DetectionResults.metrics).                                                                                                                                          |
| [`print_report`](#fiftyone.utils.eval.DetectionResults.print_report)([classes, digits])                         | Prints a classification report for the results via [`sklearn.metrics.classification_report()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.classification_report.html#sklearn.metrics.classification_report).    |
| [`report`](#fiftyone.utils.eval.DetectionResults.report)([classes])                                             | Generates a classification report for the results via [`sklearn.metrics.classification_report()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.classification_report.html#sklearn.metrics.classification_report). |
| [`save`](#fiftyone.utils.eval.DetectionResults.save)()                                                          | Saves the results to the database.                                                                                                                                                                                                     |
| [`save_config`](#fiftyone.utils.eval.DetectionResults.save_config)()                                            | Saves these results config to the database.                                                                                                                                                                                            |
| [`serialize`](#fiftyone.utils.eval.DetectionResults.serialize)([reflective])                                    | Serializes the object into a dictionary.                                                                                                                                                                                               |
| [`to_str`](#fiftyone.utils.eval.DetectionResults.to_str)([pretty_print])                                        | Returns a string representation of this object.                                                                                                                                                                                        |
| [`use_subset`](#fiftyone.utils.eval.DetectionResults.use_subset)(subset_def)                                    | Restricts the evaluation results to the specified subset.                                                                                                                                                                              |
| [`write_json`](#fiftyone.utils.eval.DetectionResults.write_json)(path[, pretty_print])                          | Serializes the object and writes it to disk.                                                                                                                                                                                           |

**Attributes:**

| [`backend`](#fiftyone.utils.eval.DetectionResults.backend)       | The `BaseRun` for these results.                                                                                                                           |
|------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`cls`](#fiftyone.utils.eval.DetectionResults.cls)               | The fully-qualified name of this `BaseRunResults` class.                                                                                                   |
| [`config`](#fiftyone.utils.eval.DetectionResults.config)         | The `BaseRunConfig` for these results.                                                                                                                     |
| [`has_subset`](#fiftyone.utils.eval.DetectionResults.has_subset) | Whether these results are currently restricted to a subset via [`use_subset()`](#fiftyone.utils.eval.DetectionResults.use_subset).                         |
| [`key`](#fiftyone.utils.eval.DetectionResults.key)               | The run key for these results.                                                                                                                             |
| [`samples`](#fiftyone.utils.eval.DetectionResults.samples)       | The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) associated with these results. |

#### add_custom_metrics(custom_metrics, overwrite=True)

Computes the given custom metrics and adds them to these results.

* **Parameters:**
  * **custom_metrics** – a list of custom metrics to compute or a dict
    mapping metric names to kwargs dicts
  * **overwrite** (*True*) – whether to recompute any custom metrics that
    have already been applied

#### attributes()

Returns the list of class attributes that will be serialized by
[`serialize()`](#fiftyone.utils.eval.DetectionResults.serialize).

* **Returns:**
  a list of attributes

#### *property* backend

The `BaseRun` for these results.

#### *static* base_results_cls(type)

Returns the results class for the given run type.

* **Parameters:**
  **type** – a `BaseRunConfig.type`
* **Returns:**
  a `BaseRunResults` subclass

#### clear_subset()

Clears the subset set by [`use_subset()`](#fiftyone.utils.eval.DetectionResults.use_subset), if any.

Subsequent operations will be performed on the full results.

#### *property* cls

The fully-qualified name of this `BaseRunResults` class.

#### *property* config

The `BaseRunConfig` for these results.

#### confusion_matrix(classes=None, include_other=False, include_missing=False)

Generates a confusion matrix for the results via
[`sklearn.metrics.confusion_matrix()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html#sklearn.metrics.confusion_matrix).

The rows of the confusion matrix represent ground truth and the columns
represent predictions.

* **Parameters:**
  * **classes** (*None*) – an optional list of classes to include in the
    confusion matrix
  * **include_other** (*False*) – whether to include an extra row/column at
    the end of the matrix for labels that do not appear in
    `classes`. Only applicable if `classes` are provided
  * **include_missing** (*False*) – whether to include a row/column at the end
    of the matrix for unmatched labels. Only applicable if
    `self.missing` does not already appear in `classes`. If
    both “other” and “missing” rows/columns are requested, this one
    is last
* **Returns:**
  a `num_classes x num_classes` confusion matrix

#### copy()

Returns a deep copy of the object.

* **Returns:**
  a Serializable instance

#### custom_attributes(dynamic=False, private=False)

Returns a customizable list of class attributes.

By default, all attributes in vars(self) are returned, minus private
attributes (those starting with “_”).

* **Parameters:**
  * **dynamic** – whether to include dynamic properties, e.g., those defined
    by getter/setter methods or the `@property` decorator. By
    default, this is False
  * **private** – whether to include private properties, i.e., those
    starting with “_”. By default, this is False
* **Returns:**
  a list of class attributes

#### *classmethod* from_dict(d, samples, config, key)

Builds a `BaseRunResults` from a JSON dict representation of
it.

* **Parameters:**
  * **d** – a JSON dict
  * **samples** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
    for the run
  * **config** – the `BaseRunConfig` for the run
  * **key** – the run key
* **Returns:**
  a `BaseRunResults`

#### *classmethod* from_json(path, \*args, \*\*kwargs)

Constructs a Serializable object from a JSON file.

Subclasses may override this method, but, by default, this method
simply reads the JSON and calls from_dict(), which subclasses must
implement.

* **Parameters:**
  * **path** – the path to the JSON file on disk
  * **\*args** – optional positional arguments for `self.from_dict()`
  * **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
  an instance of the Serializable class

#### *classmethod* from_str(s, \*args, \*\*kwargs)

Constructs a Serializable object from a JSON string.

Subclasses may override this method, but, by default, this method
simply parses the string and calls from_dict(), which subclasses must
implement.

* **Parameters:**
  * **s** – a JSON string representation of a Serializable object
  * **\*args** – optional positional arguments for `self.from_dict()`
  * **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
  an instance of the Serializable class

#### *classmethod* get_class_name()

Returns the fully-qualified class name string of this object.

#### get_meta()

Small facts that DESCRIBE these results, stored beside the run so
callers can read them without loading the results.

The results themselves are a blob in GridFS whose arrays can run to
hundreds of MB; a count or a path is a few bytes. Anything returned
here is written when the results are saved (see
`BaseRun.save_run_results()`), so no read path has to load — or
write — to answer for it.

* **Returns:**
  a JSON-serializable dict

#### *property* has_subset

Whether these results are currently restricted to a subset via
[`use_subset()`](#fiftyone.utils.eval.DetectionResults.use_subset).

#### *property* key

The run key for these results.

#### metrics(classes=None, average='micro', beta=1.0)

Computes classification metrics for the results, including accuracy,
precision, recall, and F-beta score.

See [`sklearn.metrics.precision_recall_fscore_support()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.precision_recall_fscore_support.html#sklearn.metrics.precision_recall_fscore_support) for
details.

Also includes any custom metrics from `custom_metrics`.

* **Parameters:**
  * **classes** (*None*) – an optional list of classes to include in the
    calculations
  * **average** ( *"micro"*) – the averaging strategy to use
  * **beta** (*1.0*) – the F-beta value to use
* **Returns:**
  a dict

#### plot_confusion_matrix(classes=None, include_other=None, include_missing=None, other_label='(other)', backend='plotly', \*\*kwargs)

Plots a confusion matrix for the evaluation results.

If you are working in a notebook environment with the default plotly
backend, this method returns an interactive
[`fiftyone.core.plots.plotly.InteractiveHeatmap`](fiftyone.core.plots.plotly.md#fiftyone.core.plots.plotly.InteractiveHeatmap) that you can
attach to an App session via its
[`fiftyone.core.session.Session.plots`](fiftyone.core.session.md#fiftyone.core.session.Session.plots) attribute, which will
automatically sync the session’s view with the currently selected cells
in the confusion matrix.

* **Parameters:**
  * **classes** (*None*) – an optional list of classes to include in the
    confusion matrix
  * **include_other** (*None*) – 

    whether to include a row/column for examples
    whose label is in `classes` but are matched to labels that
    do not appear in `classes`. Only applicable if `classes`
    are provided. The supported values are:
    - None (default): only include a row/column for other labels
      if there are any
    - True: do include a row/column for other labels
    - False: do not include a row/column for other labels
  * **include_missing** (*None*) – 

    whether to include a row/column for missing
    ground truth/predictions in the confusion matrix. The supported
    values are:
    - None (default): only include a row/column for missing
      labels if there are any
    - True: do include a row/column for missing labels
    - False: do not include a row/column for missing labels
  * **other_label** ( *"* *(**other* *)* *"*) – the label to use for “other” predictions
  * **backend** ( *"plotly"*) – the plotting backend to use. Supported values
    are `("plotly", "matplotlib")`
  * **\*\*kwargs** – 

    keyword arguments for the backend plotting method:
    - ”plotly” backend: [`fiftyone.core.plots.plotly.plot_confusion_matrix()`](fiftyone.core.plots.plotly.md#fiftyone.core.plots.plotly.plot_confusion_matrix)
    - ”matplotlib” backend: [`fiftyone.core.plots.matplotlib.plot_confusion_matrix()`](fiftyone.core.plots.matplotlib.md#fiftyone.core.plots.matplotlib.plot_confusion_matrix)
* **Returns:**
  - a [`fiftyone.core.plots.plotly.InteractiveHeatmap`](fiftyone.core.plots.plotly.md#fiftyone.core.plots.plotly.InteractiveHeatmap), if
    the plotly backend is used
  - a matplotlib figure, otherwise
* **Return type:**
  one of the following

#### print_metrics(classes=None, average='micro', beta=1.0, digits=2)

Prints the metrics computed via [`metrics()`](#fiftyone.utils.eval.DetectionResults.metrics).

* **Parameters:**
  * **classes** (*None*) – an optional list of classes to include in the
    calculations
  * **average** ( *"micro"*) – the averaging strategy to use
  * **beta** (*1.0*) – the F-beta value to use
  * **digits** (*2*) – the number of digits of precision to print

#### print_report(classes=None, digits=2)

Prints a classification report for the results via
[`sklearn.metrics.classification_report()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.classification_report.html#sklearn.metrics.classification_report).

* **Parameters:**
  * **classes** (*None*) – an optional list of classes to include in the
    report
  * **digits** (*2*) – the number of digits of precision to print

#### report(classes=None)

Generates a classification report for the results via
[`sklearn.metrics.classification_report()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.classification_report.html#sklearn.metrics.classification_report).

* **Parameters:**
  **classes** (*None*) – an optional list of classes to include in the
  report
* **Returns:**
  a dict

#### *property* samples

The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) associated
with these results.

#### save()

Saves the results to the database.

#### save_config()

Saves these results config to the database.

#### serialize(reflective=False)

Serializes the object into a dictionary.

Serialization is applied recursively to all attributes in the object,
including element-wise serialization of lists and dictionary values.

* **Parameters:**
  **reflective** – whether to include reflective attributes when
  serializing the object. By default, this is False
* **Returns:**
  a JSON dictionary representation of the object

#### to_str(pretty_print=True, \*\*kwargs)

Returns a string representation of this object.

* **Parameters:**
  * **pretty_print** – whether to render the JSON in human readable format
    with newlines and indentations. By default, this is True
  * **\*\*kwargs** – optional keyword arguments for `self.serialize()`
* **Returns:**
  a string representation of the object

#### use_subset(subset_def)

Restricts the evaluation results to the specified subset.

Subsequent calls to supported methods on this instance will only
contain results from the specified subset rather than the full results.

Use [`clear_subset()`](#fiftyone.utils.eval.DetectionResults.clear_subset) to reset to the full results. Or,
equivalently, use the context manager interface as demonstrated below
to automatically reset the results when the context exits.

Example usage:

```default
import fiftyone as fo
import fiftyone.zoo as foz
import fiftyone.utils.random as four
from fiftyone import ViewField as F

dataset = foz.load_zoo_dataset("quickstart")
four.random_split(dataset, {"sunny": 0.7, "cloudy": 0.2, "rainy": 0.1})

results = dataset.evaluate_detections(
    "predictions",
    gt_field="ground_truth",
    eval_key="eval",
)

counts = dataset.count_values("ground_truth.detections.label")
classes = sorted(counts, key=counts.get, reverse=True)[:5]

# Full results
results.print_report(classes=classes)

# Sunny samples
subset_def = dict(type="field", field="tags", value="sunny")
with results.use_subset(subset_def):
    results.print_report(classes=classes)

# Small objects
bbox_area = F("bounding_box")[2] * F("bounding_box")[3]
small_objects = bbox_area <= 0.05
subset_def = dict(type="attribute", expr=small_objects)
with results.use_subset(subset_def):
    results.print_report(classes=classes)
```

* **Parameters:**
  **subset_def** – 

  the subset definition, which can be:
  - a dict or list of dicts defining the subset. See above
    for examples and see [`get_subset_view()`](#fiftyone.utils.eval.get_subset_view) for full
    syntax
  - a [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView) defining the
    subset
* **Returns:**
  self

#### write_json(path, pretty_print=False, \*\*kwargs)

Serializes the object and writes it to disk.

* **Parameters:**
  * **path** – the output path
  * **pretty_print** – whether to render the JSON in human readable format
    with newlines and indentations. By default, this is False
  * **\*\*kwargs** – optional keyword arguments for `self.serialize()`

### fiftyone.utils.eval.evaluate_regressions(samples, pred_field, gt_field='ground_truth', eval_key=None, missing=None, method=None, custom_metrics=None, progress=None, \*\*kwargs)

Evaluates the regression predictions in the given collection with
respect to the specified ground truth values.

You can customize the evaluation method by passing additional
parameters for the method’s config class as `kwargs`.

The natively provided `method` values and their associated configs are:

- `"simple"`: `SimpleEvaluationConfig`

If an `eval_key` is specified, then this method will record some
statistics on each sample:

- When evaluating sample-level fields, an `eval_key` field will be
  populated on each sample recording the error of that sample’s
  prediction.
- When evaluating frame-level fields, an `eval_key` field will be
  populated on each frame recording the error of that frame’s
  prediction. In addition, an `eval_key` field will be populated on
  each sample that records the average error of the frame predictions
  of the sample.

* **Parameters:**
  * **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
  * **pred_field** – the name of the field containing the predicted
    [`fiftyone.core.labels.Regression`](fiftyone.core.labels.md#fiftyone.core.labels.Regression) instances
  * **gt_field** ( *"ground_truth"*) – the name of the field containing the
    ground truth [`fiftyone.core.labels.Regression`](fiftyone.core.labels.md#fiftyone.core.labels.Regression) instances
  * **eval_key** (*None*) – a string key to use to refer to this evaluation
  * **missing** (*None*) – a missing value. Any None-valued regressions are
    given this value for results purposes
  * **method** (*None*) – a string specifying the evaluation method to use. The
    supported values are
    `fo.evaluation_config.regression_backends.keys()` and the default
    is `fo.evaluation_config.default_regression_backend`
  * **custom_metrics** (*None*) – an optional list of custom metrics to compute
    or dict mapping metric names to kwargs dicts
  * **progress** (*None*) – whether 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
  * **\*\*kwargs** – optional keyword arguments for the constructor of the
    [`RegressionEvaluationConfig`](#fiftyone.utils.eval.RegressionEvaluationConfig) being used
* **Returns:**
  a [`RegressionResults`](#fiftyone.utils.eval.RegressionResults)

### *class* fiftyone.utils.eval.RegressionEvaluationConfig(pred_field, gt_field, custom_metrics=None, \*\*kwargs)

Bases: [`BaseEvaluationMethodConfig`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig)

Base class for configuring `RegressionEvaluation` instances.

* **Parameters:**
  * **pred_field** – the name of the field containing the predicted
    [`fiftyone.core.labels.Regression`](fiftyone.core.labels.md#fiftyone.core.labels.Regression) instances
  * **gt_field** ( *"ground_truth"*) – the name of the field containing the ground
    truth [`fiftyone.core.labels.Regression`](fiftyone.core.labels.md#fiftyone.core.labels.Regression) instances
  * **custom_metrics** (*None*) – an optional list of custom metrics to compute
    or dict mapping metric names to kwargs dicts

**Attributes:**

| [`type`](#fiftyone.utils.eval.RegressionEvaluationConfig.type)       | The type of run.                                        |
|----------------------------------------------------------------------|---------------------------------------------------------|
| [`cls`](#fiftyone.utils.eval.RegressionEvaluationConfig.cls)         | The fully-qualified name of this `BaseRunConfig` class. |
| [`method`](#fiftyone.utils.eval.RegressionEvaluationConfig.method)   | The name of the method.                                 |
| [`run_cls`](#fiftyone.utils.eval.RegressionEvaluationConfig.run_cls) | The `BaseRun` class associated with this config.        |

**Methods:**

| [`attributes`](#fiftyone.utils.eval.RegressionEvaluationConfig.attributes)()                                                 | Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.utils.eval.RegressionEvaluationConfig.serialize).   |
|------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| [`base_config_cls`](#fiftyone.utils.eval.RegressionEvaluationConfig.base_config_cls)(type)                                   | Returns the config class for the given run type.                                                                                              |
| [`build`](#fiftyone.utils.eval.RegressionEvaluationConfig.build)()                                                           | Builds the `BaseRun` instance associated with this config.                                                                                    |
| [`builder`](#fiftyone.utils.eval.RegressionEvaluationConfig.builder)()                                                       | Returns a ConfigBuilder instance for this class.                                                                                              |
| [`copy`](#fiftyone.utils.eval.RegressionEvaluationConfig.copy)()                                                             | Returns a deep copy of the object.                                                                                                            |
| [`custom_attributes`](#fiftyone.utils.eval.RegressionEvaluationConfig.custom_attributes)([dynamic, private])                 | Returns a customizable list of class attributes.                                                                                              |
| [`default`](#fiftyone.utils.eval.RegressionEvaluationConfig.default)()                                                       | Returns the default config instance.                                                                                                          |
| [`from_dict`](#fiftyone.utils.eval.RegressionEvaluationConfig.from_dict)(d)                                                  | Constructs a `BaseRunConfig` from a serialized JSON dict representation of it.                                                                |
| [`from_json`](#fiftyone.utils.eval.RegressionEvaluationConfig.from_json)(path, \*args, \*\*kwargs)                           | Constructs a Serializable object from a JSON file.                                                                                            |
| [`from_kwargs`](#fiftyone.utils.eval.RegressionEvaluationConfig.from_kwargs)(\*\*kwargs)                                     | Constructs a Config object from keyword arguments.                                                                                            |
| [`from_str`](#fiftyone.utils.eval.RegressionEvaluationConfig.from_str)(s, \*args, \*\*kwargs)                                | Constructs a Serializable object from a JSON string.                                                                                          |
| [`get_class_name`](#fiftyone.utils.eval.RegressionEvaluationConfig.get_class_name)()                                         | Returns the fully-qualified class name string of this object.                                                                                 |
| [`load_credentials`](#fiftyone.utils.eval.RegressionEvaluationConfig.load_credentials)(\*\*kwargs)                           | Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config.                                             |
| [`load_default`](#fiftyone.utils.eval.RegressionEvaluationConfig.load_default)()                                             | Loads the default config instance from file.                                                                                                  |
| [`parse_array`](#fiftyone.utils.eval.RegressionEvaluationConfig.parse_array)(d, key[, default])                              | Parses a raw array attribute.                                                                                                                 |
| [`parse_bool`](#fiftyone.utils.eval.RegressionEvaluationConfig.parse_bool)(d, key[, default])                                | Parses a boolean value.                                                                                                                       |
| [`parse_categorical`](#fiftyone.utils.eval.RegressionEvaluationConfig.parse_categorical)(d, key, choices[, default])         | Parses a categorical JSON field, which must take a value from among the given choices.                                                        |
| [`parse_dict`](#fiftyone.utils.eval.RegressionEvaluationConfig.parse_dict)(d, key[, default])                                | Parses a dictionary attribute.                                                                                                                |
| [`parse_int`](#fiftyone.utils.eval.RegressionEvaluationConfig.parse_int)(d, key[, default])                                  | Parses an integer attribute.                                                                                                                  |
| [`parse_mutually_exclusive_fields`](#fiftyone.utils.eval.RegressionEvaluationConfig.parse_mutually_exclusive_fields)(fields) | Parses a mutually exclusive dictionary of pre-parsed fields, which must contain exactly one field with a truthy value.                        |
| [`parse_number`](#fiftyone.utils.eval.RegressionEvaluationConfig.parse_number)(d, key[, default])                            | Parses a number attribute.                                                                                                                    |
| [`parse_object`](#fiftyone.utils.eval.RegressionEvaluationConfig.parse_object)(d, key, cls[, default])                       | Parses an object attribute.                                                                                                                   |
| [`parse_object_array`](#fiftyone.utils.eval.RegressionEvaluationConfig.parse_object_array)(d, key, cls[, default])           | Parses an array of objects.                                                                                                                   |
| [`parse_object_dict`](#fiftyone.utils.eval.RegressionEvaluationConfig.parse_object_dict)(d, key, cls[, default])             | Parses a dictionary whose values are objects.                                                                                                 |
| [`parse_path`](#fiftyone.utils.eval.RegressionEvaluationConfig.parse_path)(d, key[, default])                                | Parses a path attribute.                                                                                                                      |
| [`parse_raw`](#fiftyone.utils.eval.RegressionEvaluationConfig.parse_raw)(d, key[, default])                                  | Parses a raw (arbitrary) JSON field.                                                                                                          |
| [`parse_string`](#fiftyone.utils.eval.RegressionEvaluationConfig.parse_string)(d, key[, default])                            | Parses a string attribute.                                                                                                                    |
| [`serialize`](#fiftyone.utils.eval.RegressionEvaluationConfig.serialize)([reflective])                                       | Serializes the object into a dictionary.                                                                                                      |
| [`to_str`](#fiftyone.utils.eval.RegressionEvaluationConfig.to_str)([pretty_print])                                           | Returns a string representation of this object.                                                                                               |
| [`validate_all_or_nothing_fields`](#fiftyone.utils.eval.RegressionEvaluationConfig.validate_all_or_nothing_fields)(fields)   | Validates a dictionary of pre-parsed fields checking that either all or none of the fields have a truthy value.                               |
| [`write_json`](#fiftyone.utils.eval.RegressionEvaluationConfig.write_json)(path[, pretty_print])                             | Serializes the object and writes it to disk.                                                                                                  |

#### *property* type

The type of run.

#### attributes()

Returns the list of class attributes that will be serialized by
[`serialize()`](#fiftyone.utils.eval.RegressionEvaluationConfig.serialize).

* **Returns:**
  a list of attributes

#### *static* base_config_cls(type)

Returns the config class for the given run type.

* **Parameters:**
  **type** – a `BaseRunConfig.type`
* **Returns:**
  a `BaseRunConfig` subclass

#### build()

Builds the `BaseRun` instance associated with this config.

* **Returns:**
  a `BaseRun` instance

#### *classmethod* builder()

Returns a ConfigBuilder instance for this class.

#### *property* cls

The fully-qualified name of this `BaseRunConfig` class.

#### copy()

Returns a deep copy of the object.

* **Returns:**
  a Serializable instance

#### custom_attributes(dynamic=False, private=False)

Returns a customizable list of class attributes.

By default, all attributes in vars(self) are returned, minus private
attributes (those starting with “_”).

* **Parameters:**
  * **dynamic** – whether to include dynamic properties, e.g., those defined
    by getter/setter methods or the `@property` decorator. By
    default, this is False
  * **private** – whether to include private properties, i.e., those
    starting with “_”. By default, this is False
* **Returns:**
  a list of class attributes

#### *classmethod* default()

Returns the default config instance.

By default, this method instantiates the class from an empty
dictionary, which will only succeed if all attributes are optional.
Otherwise, subclasses should override this method to provide the
desired default configuration.

#### *classmethod* from_dict(d)

Constructs a `BaseRunConfig` from a serialized JSON dict
representation of it.

* **Parameters:**
  **d** – a JSON dict
* **Returns:**
  a `BaseRunConfig`

#### *classmethod* from_json(path, \*args, \*\*kwargs)

Constructs a Serializable object from a JSON file.

Subclasses may override this method, but, by default, this method
simply reads the JSON and calls from_dict(), which subclasses must
implement.

* **Parameters:**
  * **path** – the path to the JSON file on disk
  * **\*args** – optional positional arguments for `self.from_dict()`
  * **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
  an instance of the Serializable class

#### *classmethod* from_kwargs(\*\*kwargs)

Constructs a Config object from keyword arguments.

* **Parameters:**
  **\*\*kwargs** – keyword arguments that define the fields expected by cls
* **Returns:**
  an instance of cls

#### *classmethod* from_str(s, \*args, \*\*kwargs)

Constructs a Serializable object from a JSON string.

Subclasses may override this method, but, by default, this method
simply parses the string and calls from_dict(), which subclasses must
implement.

* **Parameters:**
  * **s** – a JSON string representation of a Serializable object
  * **\*args** – optional positional arguments for `self.from_dict()`
  * **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
  an instance of the Serializable class

#### *classmethod* get_class_name()

Returns the fully-qualified class name string of this object.

#### load_credentials(\*\*kwargs)

Loads any necessary credentials from the given keyword arguments or
the relevant FiftyOne config.

* **Parameters:**
  **\*\*kwargs** – subclass-specific credentials

#### *classmethod* load_default()

Loads the default config instance from file.

Subclasses must implement this method if they intend to support
default instances.

#### *property* method

The name of the method.

#### *static* parse_array(d, key, default=<eta.core.config.NoDefault object>)

Parses a raw array attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default list to return if key is not present
* **Returns:**
  a list of raw (untouched) values
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_bool(d, key, default=<eta.core.config.NoDefault object>)

Parses a boolean value.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default bool to return if key is not present
* **Returns:**
  True/False
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_categorical(d, key, choices, default=<eta.core.config.NoDefault object>)

Parses a categorical JSON field, which must take a value from among
the given choices.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **choices** – either an iterable of possible values or an enum-like
    class whose attributes define the possible values
  * **default** – a default value to return if key is not present
* **Returns:**
  the raw (untouched) value of the given field, which is equal to a
  value from `choices`
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the key was present in the dictionary but its value
      was not an allowed choice, or if no default value was provided
      and the key was not found in the dictionary

#### *static* parse_dict(d, key, default=<eta.core.config.NoDefault object>)

Parses a dictionary attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default dict to return if key is not present
* **Returns:**
  a dictionary
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_int(d, key, default=<eta.core.config.NoDefault object>)

Parses an integer attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default integer value to return if key is not present
* **Returns:**
  an int
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_mutually_exclusive_fields(fields)

Parses a mutually exclusive dictionary of pre-parsed fields, which
must contain exactly one field with a truthy value.

* **Parameters:**
  **fields** – a dictionary of pre-parsed fields
* **Returns:**
  the (field, value) that was set
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if zero or more than one truthy value was found

#### *static* parse_number(d, key, default=<eta.core.config.NoDefault object>)

Parses a number attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default numeric value to return if key is not present
* **Returns:**
  a number (e.g. int, float)
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_object(d, key, cls, default=<eta.core.config.NoDefault object>)

Parses an object attribute.

The value of d[key] can be either an instance of cls or a serialized
dict from an instance of cls.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **cls** – the class of d[key]
  * **default** – a default cls instance to return if key is not present
* **Returns:**
  an instance of cls
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_object_array(d, key, cls, default=<eta.core.config.NoDefault object>)

Parses an array of objects.

The values in d[key] can be either instances of cls or serialized
dicts from instances of cls.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **cls** – the class of the elements of list d[key]
  * **default** – the default list to return if key is not present
* **Returns:**
  a list of cls instances
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_object_dict(d, key, cls, default=<eta.core.config.NoDefault object>)

Parses a dictionary whose values are objects.

The values in d[key] can be either instances of cls or serialized
dicts from instances of cls.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **cls** – the class of the values of dictionary d[key]
  * **default** – the default dict of cls instances to return if key is not
    present
* **Returns:**
  a dictionary whose values are cls instances
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_path(d, key, default=<eta.core.config.NoDefault object>)

Parses a path attribute.

The path is converted to an absolute path if necessary via
`os.path.abspath(os.path.expanduser(value))`.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default string to return if key is not present
* **Returns:**
  a path string
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_raw(d, key, default=<eta.core.config.NoDefault object>)

Parses a raw (arbitrary) JSON field.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default value to return if key is not present
* **Returns:**
  the raw (untouched) value of the given field
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if no default value was provided and the key was not
      found in the dictionary

#### *static* parse_string(d, key, default=<eta.core.config.NoDefault object>)

Parses a string attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default string to return if key is not present
* **Returns:**
  a string
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *property* run_cls

The `BaseRun` class associated with this config.

#### serialize(reflective=False)

Serializes the object into a dictionary.

Serialization is applied recursively to all attributes in the object,
including element-wise serialization of lists and dictionary values.

* **Parameters:**
  **reflective** – whether to include reflective attributes when
  serializing the object. By default, this is False
* **Returns:**
  a JSON dictionary representation of the object

#### to_str(pretty_print=True, \*\*kwargs)

Returns a string representation of this object.

* **Parameters:**
  * **pretty_print** – whether to render the JSON in human readable format
    with newlines and indentations. By default, this is True
  * **\*\*kwargs** – optional keyword arguments for `self.serialize()`
* **Returns:**
  a string representation of the object

#### *static* validate_all_or_nothing_fields(fields)

Validates a dictionary of pre-parsed fields checking that either
all or none of the fields have a truthy value.

* **Parameters:**
  **fields** – a dictionary of pre-parsed fields
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if some values are truth and some are not

#### write_json(path, pretty_print=False, \*\*kwargs)

Serializes the object and writes it to disk.

* **Parameters:**
  * **path** – the output path
  * **pretty_print** – whether to render the JSON in human readable format
    with newlines and indentations. By default, this is False
  * **\*\*kwargs** – optional keyword arguments for `self.serialize()`

### *class* fiftyone.utils.eval.RegressionResults(samples, config, eval_key, ytrue, ypred, confs=None, ids=None, missing=None, custom_metrics=None, backend=None)

Bases: [`BaseEvaluationResults`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationResults)

Class that stores the results of a regression evaluation.

* **Parameters:**
  * **samples** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) used
  * **config** – the [`RegressionEvaluationConfig`](#fiftyone.utils.eval.RegressionEvaluationConfig) used
  * **eval_key** (*None*) – the evaluation key
  * **ytrue** – a list of ground truth values
  * **ypred** – a list of predicted values
  * **confs** (*None*) – an optional list of confidences for the predictions
  * **eval_key** – the evaluation key of the evaluation
  * **gt_field** (*None*) – the name of the ground truth field
  * **pred_field** (*None*) – the name of the predictions field
  * **ids** (*None*) – a list of sample or frame IDs corresponding to the
    regressions
  * **missing** (*None*) – a missing value. Any None-valued regressions are
    given this value for results purposes
  * **custom_metrics** (*None*) – an optional dict of custom metrics
  * **backend** (*None*) – a `RegressionEvaluation` backend

**Methods:**

| [`metrics`](#fiftyone.utils.eval.RegressionResults.metrics)([weights])                                         | Computes various popular regression metrics for the results.                                                                       |
|----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
| [`print_metrics`](#fiftyone.utils.eval.RegressionResults.print_metrics)([weights, digits])                     | Prints the metrics computed via [`metrics()`](#fiftyone.utils.eval.RegressionResults.metrics).                                     |
| [`plot_results`](#fiftyone.utils.eval.RegressionResults.plot_results)([labels, sizes, backend])                | Plots the regression results.                                                                                                      |
| [`add_custom_metrics`](#fiftyone.utils.eval.RegressionResults.add_custom_metrics)(custom_metrics[, overwrite]) | Computes the given custom metrics and adds them to these results.                                                                  |
| [`attributes`](#fiftyone.utils.eval.RegressionResults.attributes)()                                            | Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.utils.eval.RegressionResults.serialize). |
| [`base_results_cls`](#fiftyone.utils.eval.RegressionResults.base_results_cls)(type)                            | Returns the results class for the given run type.                                                                                  |
| [`copy`](#fiftyone.utils.eval.RegressionResults.copy)()                                                        | Returns a deep copy of the object.                                                                                                 |
| [`custom_attributes`](#fiftyone.utils.eval.RegressionResults.custom_attributes)([dynamic, private])            | Returns a customizable list of class attributes.                                                                                   |
| [`from_dict`](#fiftyone.utils.eval.RegressionResults.from_dict)(d, samples, config, key)                       | Builds a `BaseRunResults` from a JSON dict representation of it.                                                                   |
| [`from_json`](#fiftyone.utils.eval.RegressionResults.from_json)(path, \*args, \*\*kwargs)                      | Constructs a Serializable object from a JSON file.                                                                                 |
| [`from_str`](#fiftyone.utils.eval.RegressionResults.from_str)(s, \*args, \*\*kwargs)                           | Constructs a Serializable object from a JSON string.                                                                               |
| [`get_class_name`](#fiftyone.utils.eval.RegressionResults.get_class_name)()                                    | Returns the fully-qualified class name string of this object.                                                                      |
| [`get_meta`](#fiftyone.utils.eval.RegressionResults.get_meta)()                                                | Small facts that DESCRIBE these results, stored beside the run so callers can read them without loading the results.               |
| [`save`](#fiftyone.utils.eval.RegressionResults.save)()                                                        | Saves the results to the database.                                                                                                 |
| [`save_config`](#fiftyone.utils.eval.RegressionResults.save_config)()                                          | Saves these results config to the database.                                                                                        |
| [`serialize`](#fiftyone.utils.eval.RegressionResults.serialize)([reflective])                                  | Serializes the object into a dictionary.                                                                                           |
| [`to_str`](#fiftyone.utils.eval.RegressionResults.to_str)([pretty_print])                                      | Returns a string representation of this object.                                                                                    |
| [`write_json`](#fiftyone.utils.eval.RegressionResults.write_json)(path[, pretty_print])                        | Serializes the object and writes it to disk.                                                                                       |

**Attributes:**

| [`backend`](#fiftyone.utils.eval.RegressionResults.backend)   | The `BaseRun` for these results.                                                                                                                           |
|---------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`cls`](#fiftyone.utils.eval.RegressionResults.cls)           | The fully-qualified name of this `BaseRunResults` class.                                                                                                   |
| [`config`](#fiftyone.utils.eval.RegressionResults.config)     | The `BaseRunConfig` for these results.                                                                                                                     |
| [`key`](#fiftyone.utils.eval.RegressionResults.key)           | The run key for these results.                                                                                                                             |
| [`samples`](#fiftyone.utils.eval.RegressionResults.samples)   | The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) associated with these results. |

#### metrics(weights=None)

Computes various popular regression metrics for the results.

The computed metrics are:

- Mean squared error: [`sklearn.metrics.mean_squared_error()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.mean_squared_error.html#sklearn.metrics.mean_squared_error)
- Root mean squared error: [`sklearn.metrics.mean_squared_error()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.mean_squared_error.html#sklearn.metrics.mean_squared_error)
- Mean absolute error: [`sklearn.metrics.mean_absolute_error()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.mean_absolute_error.html#sklearn.metrics.mean_absolute_error)
- Median absolute error: [`sklearn.metrics.median_absolute_error()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.median_absolute_error.html#sklearn.metrics.median_absolute_error)
- R^2 score: [`sklearn.metrics.r2_score()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.r2_score.html#sklearn.metrics.r2_score)
- Explained variance score: [`sklearn.metrics.explained_variance_score()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.explained_variance_score.html#sklearn.metrics.explained_variance_score)
- Max error: [`sklearn.metrics.max_error()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.max_error.html#sklearn.metrics.max_error)
- Support: the number of examples

Also includes any custom metrics from `custom_metrics`.

* **Parameters:**
  **weights** (*None*) – an optional list of weights for each example
* **Returns:**
  a dict

#### print_metrics(weights=None, digits=2)

Prints the metrics computed via [`metrics()`](#fiftyone.utils.eval.RegressionResults.metrics).

* **Parameters:**
  * **weights** (*None*) – an optional list of weights for each example
  * **digits** (*2*) – the number of digits of precision to print

#### plot_results(labels=None, sizes=None, backend='plotly', \*\*kwargs)

Plots the regression results.

You can use the `labels` parameters to define a coloring for the
points, and you can use the `sizes` parameter to scale the sizes of
the points.

You can attach plots generated by this method to an App session via its
[`fiftyone.core.session.Session.plots`](fiftyone.core.session.md#fiftyone.core.session.Session.plots) attribute, which will
automatically sync the session’s view with the currently selected
points in the plot.

* **Parameters:**
  * **labels** (*None*) – 

    data to use to color the points. Can be any of the
    following:
    - the name of a sample field or `embedded.field.name` of
      from which to extract numeric or string values
    - a [`fiftyone.core.expressions.ViewExpression`](fiftyone.core.expressions.md#fiftyone.core.expressions.ViewExpression)
      defining numeric or string values to extract via
      [`fiftyone.core.collections.SampleCollection.values()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.values)
    - a list or array-like of numeric or string values (or lists
      of lists for frame-level regressions)
  * **sizes** (*None*) – 

    data to use to scale the sizes of the points. Can be
    any of the following:
    - the name of a sample field or `embedded.field.name` from
      which to extract numeric values
    - a [`fiftyone.core.expressions.ViewExpression`](fiftyone.core.expressions.md#fiftyone.core.expressions.ViewExpression)
      defining numeric values to extract via
      [`fiftyone.core.collections.SampleCollection.values()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.values)
    - a list or array-like of numeric values (or lists of lists
      for frame-level regressions)
  * **backend** ( *"plotly"*) – the plotting backend to use. Supported values
    are `("plotly", "matplotlib")`
  * **\*\*kwargs** – 

    keyword arguments for the backend plotting method:
    - ”plotly” backend: [`fiftyone.core.plots.plotly.plot_regressions()`](fiftyone.core.plots.plotly.md#fiftyone.core.plots.plotly.plot_regressions)
    - ”matplotlib” backend: [`fiftyone.core.plots.matplotlib.plot_regressions()`](fiftyone.core.plots.matplotlib.md#fiftyone.core.plots.matplotlib.plot_regressions)
* **Returns:**
  an [`fiftyone.core.plots.base.InteractivePlot`](fiftyone.core.plots.base.md#fiftyone.core.plots.base.InteractivePlot)

#### add_custom_metrics(custom_metrics, overwrite=True)

Computes the given custom metrics and adds them to these results.

* **Parameters:**
  * **custom_metrics** – a list of custom metrics to compute or a dict
    mapping metric names to kwargs dicts
  * **overwrite** (*True*) – whether to recompute any custom metrics that
    have already been applied

#### attributes()

Returns the list of class attributes that will be serialized by
[`serialize()`](#fiftyone.utils.eval.RegressionResults.serialize).

* **Returns:**
  a list of attributes

#### *property* backend

The `BaseRun` for these results.

#### *static* base_results_cls(type)

Returns the results class for the given run type.

* **Parameters:**
  **type** – a `BaseRunConfig.type`
* **Returns:**
  a `BaseRunResults` subclass

#### *property* cls

The fully-qualified name of this `BaseRunResults` class.

#### *property* config

The `BaseRunConfig` for these results.

#### copy()

Returns a deep copy of the object.

* **Returns:**
  a Serializable instance

#### custom_attributes(dynamic=False, private=False)

Returns a customizable list of class attributes.

By default, all attributes in vars(self) are returned, minus private
attributes (those starting with “_”).

* **Parameters:**
  * **dynamic** – whether to include dynamic properties, e.g., those defined
    by getter/setter methods or the `@property` decorator. By
    default, this is False
  * **private** – whether to include private properties, i.e., those
    starting with “_”. By default, this is False
* **Returns:**
  a list of class attributes

#### *classmethod* from_dict(d, samples, config, key)

Builds a `BaseRunResults` from a JSON dict representation of
it.

* **Parameters:**
  * **d** – a JSON dict
  * **samples** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
    for the run
  * **config** – the `BaseRunConfig` for the run
  * **key** – the run key
* **Returns:**
  a `BaseRunResults`

#### *classmethod* from_json(path, \*args, \*\*kwargs)

Constructs a Serializable object from a JSON file.

Subclasses may override this method, but, by default, this method
simply reads the JSON and calls from_dict(), which subclasses must
implement.

* **Parameters:**
  * **path** – the path to the JSON file on disk
  * **\*args** – optional positional arguments for `self.from_dict()`
  * **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
  an instance of the Serializable class

#### *classmethod* from_str(s, \*args, \*\*kwargs)

Constructs a Serializable object from a JSON string.

Subclasses may override this method, but, by default, this method
simply parses the string and calls from_dict(), which subclasses must
implement.

* **Parameters:**
  * **s** – a JSON string representation of a Serializable object
  * **\*args** – optional positional arguments for `self.from_dict()`
  * **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
  an instance of the Serializable class

#### *classmethod* get_class_name()

Returns the fully-qualified class name string of this object.

#### get_meta()

Small facts that DESCRIBE these results, stored beside the run so
callers can read them without loading the results.

The results themselves are a blob in GridFS whose arrays can run to
hundreds of MB; a count or a path is a few bytes. Anything returned
here is written when the results are saved (see
`BaseRun.save_run_results()`), so no read path has to load — or
write — to answer for it.

* **Returns:**
  a JSON-serializable dict

#### *property* key

The run key for these results.

#### *property* samples

The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) associated
with these results.

#### save()

Saves the results to the database.

#### save_config()

Saves these results config to the database.

#### serialize(reflective=False)

Serializes the object into a dictionary.

Serialization is applied recursively to all attributes in the object,
including element-wise serialization of lists and dictionary values.

* **Parameters:**
  **reflective** – whether to include reflective attributes when
  serializing the object. By default, this is False
* **Returns:**
  a JSON dictionary representation of the object

#### to_str(pretty_print=True, \*\*kwargs)

Returns a string representation of this object.

* **Parameters:**
  * **pretty_print** – whether to render the JSON in human readable format
    with newlines and indentations. By default, this is True
  * **\*\*kwargs** – optional keyword arguments for `self.serialize()`
* **Returns:**
  a string representation of the object

#### write_json(path, pretty_print=False, \*\*kwargs)

Serializes the object and writes it to disk.

* **Parameters:**
  * **path** – the output path
  * **pretty_print** – whether to render the JSON in human readable format
    with newlines and indentations. By default, this is False
  * **\*\*kwargs** – optional keyword arguments for `self.serialize()`

### fiftyone.utils.eval.evaluate_segmentations(samples, pred_field, gt_field='ground_truth', eval_key=None, mask_targets=None, method=None, custom_metrics=None, progress=None, \*\*kwargs)

Evaluates the specified semantic segmentation masks in the given
collection with respect to the specified ground truth masks.

If the size of a predicted mask does not match the ground truth mask, it
is resized to match the ground truth.

By default, this method simply performs pixelwise evaluation of the full
masks, but other strategies such as boundary-only evaluation can be
configured by passing additional parameters for the method’s config class
as `kwargs`.

The natively provided `method` values and their associated configs are:

- `"simple"`: `SimpleEvaluationConfig`

If an `eval_key` is provided, the accuracy, precision, and recall of each
sample is recorded in top-level fields of each sample:

```default
 Accuracy: sample.<eval_key>_accuracy
Precision: sample.<eval_key>_precision
   Recall: sample.<eval_key>_recall
```

In addition, when evaluating frame-level masks, the accuracy, precision,
and recall of each frame if recorded in the following frame-level fields:

```default
 Accuracy: frame.<eval_key>_accuracy
Precision: frame.<eval_key>_precision
   Recall: frame.<eval_key>_recall
```

#### NOTE
The mask values `0` and `#000000` are treated as a background class
for the purposes of computing evaluation metrics like precision and
recall.

* **Parameters:**
  * **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
  * **pred_field** – the name of the field containing the predicted
    [`fiftyone.core.labels.Segmentation`](fiftyone.core.labels.md#fiftyone.core.labels.Segmentation) instances
  * **gt_field** ( *"ground_truth"*) – the name of the field containing the ground
    truth [`fiftyone.core.labels.Segmentation`](fiftyone.core.labels.md#fiftyone.core.labels.Segmentation) instances
  * **eval_key** (*None*) – an evaluation key to use to refer to this evaluation
  * **mask_targets** (*None*) – a dict mapping pixel values or RGB hex strings to
    labels. If not provided, the observed values are used as labels
  * **method** (*None*) – a string specifying the evaluation method to use. The
    supported values are
    `fo.evaluation_config.segmentation_backends.keys()` and the
    default is `fo.evaluation_config.default_segmentation_backend`
  * **custom_metrics** (*None*) – an optional list of custom metrics to compute
    or dict mapping metric names to kwargs dicts
  * **progress** (*None*) – whether 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
  * **\*\*kwargs** – optional keyword arguments for the constructor of the
    [`SegmentationEvaluationConfig`](#fiftyone.utils.eval.SegmentationEvaluationConfig) being used
* **Returns:**
  a [`SegmentationResults`](#fiftyone.utils.eval.SegmentationResults)

### *class* fiftyone.utils.eval.SegmentationEvaluationConfig(pred_field, gt_field, compute_dice=False, custom_metrics=None, \*\*kwargs)

Bases: [`BaseEvaluationMethodConfig`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseEvaluationMethodConfig)

Base class for configuring `SegmentationEvaluation` instances.

* **Parameters:**
  * **pred_field** – the name of the field containing the predicted
    [`fiftyone.core.labels.Segmentation`](fiftyone.core.labels.md#fiftyone.core.labels.Segmentation) instances
  * **gt_field** – the name of the field containing the ground truth
    [`fiftyone.core.labels.Segmentation`](fiftyone.core.labels.md#fiftyone.core.labels.Segmentation) instances
  * **compute_dice** (*False*) – whether to compute the Dice coefficient for each
    sample
  * **custom_metrics** (*None*) – an optional list of custom metrics to compute
    or dict mapping metric names to kwargs dicts

**Attributes:**

| [`type`](#fiftyone.utils.eval.SegmentationEvaluationConfig.type)       | The type of run.                                        |
|------------------------------------------------------------------------|---------------------------------------------------------|
| [`cls`](#fiftyone.utils.eval.SegmentationEvaluationConfig.cls)         | The fully-qualified name of this `BaseRunConfig` class. |
| [`method`](#fiftyone.utils.eval.SegmentationEvaluationConfig.method)   | The name of the method.                                 |
| [`run_cls`](#fiftyone.utils.eval.SegmentationEvaluationConfig.run_cls) | The `BaseRun` class associated with this config.        |

**Methods:**

| [`attributes`](#fiftyone.utils.eval.SegmentationEvaluationConfig.attributes)()                                                 | Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.utils.eval.SegmentationEvaluationConfig.serialize).   |
|--------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| [`base_config_cls`](#fiftyone.utils.eval.SegmentationEvaluationConfig.base_config_cls)(type)                                   | Returns the config class for the given run type.                                                                                                |
| [`build`](#fiftyone.utils.eval.SegmentationEvaluationConfig.build)()                                                           | Builds the `BaseRun` instance associated with this config.                                                                                      |
| [`builder`](#fiftyone.utils.eval.SegmentationEvaluationConfig.builder)()                                                       | Returns a ConfigBuilder instance for this class.                                                                                                |
| [`copy`](#fiftyone.utils.eval.SegmentationEvaluationConfig.copy)()                                                             | Returns a deep copy of the object.                                                                                                              |
| [`custom_attributes`](#fiftyone.utils.eval.SegmentationEvaluationConfig.custom_attributes)([dynamic, private])                 | Returns a customizable list of class attributes.                                                                                                |
| [`default`](#fiftyone.utils.eval.SegmentationEvaluationConfig.default)()                                                       | Returns the default config instance.                                                                                                            |
| [`from_dict`](#fiftyone.utils.eval.SegmentationEvaluationConfig.from_dict)(d)                                                  | Constructs a `BaseRunConfig` from a serialized JSON dict representation of it.                                                                  |
| [`from_json`](#fiftyone.utils.eval.SegmentationEvaluationConfig.from_json)(path, \*args, \*\*kwargs)                           | Constructs a Serializable object from a JSON file.                                                                                              |
| [`from_kwargs`](#fiftyone.utils.eval.SegmentationEvaluationConfig.from_kwargs)(\*\*kwargs)                                     | Constructs a Config object from keyword arguments.                                                                                              |
| [`from_str`](#fiftyone.utils.eval.SegmentationEvaluationConfig.from_str)(s, \*args, \*\*kwargs)                                | Constructs a Serializable object from a JSON string.                                                                                            |
| [`get_class_name`](#fiftyone.utils.eval.SegmentationEvaluationConfig.get_class_name)()                                         | Returns the fully-qualified class name string of this object.                                                                                   |
| [`load_credentials`](#fiftyone.utils.eval.SegmentationEvaluationConfig.load_credentials)(\*\*kwargs)                           | Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config.                                               |
| [`load_default`](#fiftyone.utils.eval.SegmentationEvaluationConfig.load_default)()                                             | Loads the default config instance from file.                                                                                                    |
| [`parse_array`](#fiftyone.utils.eval.SegmentationEvaluationConfig.parse_array)(d, key[, default])                              | Parses a raw array attribute.                                                                                                                   |
| [`parse_bool`](#fiftyone.utils.eval.SegmentationEvaluationConfig.parse_bool)(d, key[, default])                                | Parses a boolean value.                                                                                                                         |
| [`parse_categorical`](#fiftyone.utils.eval.SegmentationEvaluationConfig.parse_categorical)(d, key, choices[, default])         | Parses a categorical JSON field, which must take a value from among the given choices.                                                          |
| [`parse_dict`](#fiftyone.utils.eval.SegmentationEvaluationConfig.parse_dict)(d, key[, default])                                | Parses a dictionary attribute.                                                                                                                  |
| [`parse_int`](#fiftyone.utils.eval.SegmentationEvaluationConfig.parse_int)(d, key[, default])                                  | Parses an integer attribute.                                                                                                                    |
| [`parse_mutually_exclusive_fields`](#fiftyone.utils.eval.SegmentationEvaluationConfig.parse_mutually_exclusive_fields)(fields) | Parses a mutually exclusive dictionary of pre-parsed fields, which must contain exactly one field with a truthy value.                          |
| [`parse_number`](#fiftyone.utils.eval.SegmentationEvaluationConfig.parse_number)(d, key[, default])                            | Parses a number attribute.                                                                                                                      |
| [`parse_object`](#fiftyone.utils.eval.SegmentationEvaluationConfig.parse_object)(d, key, cls[, default])                       | Parses an object attribute.                                                                                                                     |
| [`parse_object_array`](#fiftyone.utils.eval.SegmentationEvaluationConfig.parse_object_array)(d, key, cls[, default])           | Parses an array of objects.                                                                                                                     |
| [`parse_object_dict`](#fiftyone.utils.eval.SegmentationEvaluationConfig.parse_object_dict)(d, key, cls[, default])             | Parses a dictionary whose values are objects.                                                                                                   |
| [`parse_path`](#fiftyone.utils.eval.SegmentationEvaluationConfig.parse_path)(d, key[, default])                                | Parses a path attribute.                                                                                                                        |
| [`parse_raw`](#fiftyone.utils.eval.SegmentationEvaluationConfig.parse_raw)(d, key[, default])                                  | Parses a raw (arbitrary) JSON field.                                                                                                            |
| [`parse_string`](#fiftyone.utils.eval.SegmentationEvaluationConfig.parse_string)(d, key[, default])                            | Parses a string attribute.                                                                                                                      |
| [`serialize`](#fiftyone.utils.eval.SegmentationEvaluationConfig.serialize)([reflective])                                       | Serializes the object into a dictionary.                                                                                                        |
| [`to_str`](#fiftyone.utils.eval.SegmentationEvaluationConfig.to_str)([pretty_print])                                           | Returns a string representation of this object.                                                                                                 |
| [`validate_all_or_nothing_fields`](#fiftyone.utils.eval.SegmentationEvaluationConfig.validate_all_or_nothing_fields)(fields)   | Validates a dictionary of pre-parsed fields checking that either all or none of the fields have a truthy value.                                 |
| [`write_json`](#fiftyone.utils.eval.SegmentationEvaluationConfig.write_json)(path[, pretty_print])                             | Serializes the object and writes it to disk.                                                                                                    |

#### *property* type

The type of run.

#### attributes()

Returns the list of class attributes that will be serialized by
[`serialize()`](#fiftyone.utils.eval.SegmentationEvaluationConfig.serialize).

* **Returns:**
  a list of attributes

#### *static* base_config_cls(type)

Returns the config class for the given run type.

* **Parameters:**
  **type** – a `BaseRunConfig.type`
* **Returns:**
  a `BaseRunConfig` subclass

#### build()

Builds the `BaseRun` instance associated with this config.

* **Returns:**
  a `BaseRun` instance

#### *classmethod* builder()

Returns a ConfigBuilder instance for this class.

#### *property* cls

The fully-qualified name of this `BaseRunConfig` class.

#### copy()

Returns a deep copy of the object.

* **Returns:**
  a Serializable instance

#### custom_attributes(dynamic=False, private=False)

Returns a customizable list of class attributes.

By default, all attributes in vars(self) are returned, minus private
attributes (those starting with “_”).

* **Parameters:**
  * **dynamic** – whether to include dynamic properties, e.g., those defined
    by getter/setter methods or the `@property` decorator. By
    default, this is False
  * **private** – whether to include private properties, i.e., those
    starting with “_”. By default, this is False
* **Returns:**
  a list of class attributes

#### *classmethod* default()

Returns the default config instance.

By default, this method instantiates the class from an empty
dictionary, which will only succeed if all attributes are optional.
Otherwise, subclasses should override this method to provide the
desired default configuration.

#### *classmethod* from_dict(d)

Constructs a `BaseRunConfig` from a serialized JSON dict
representation of it.

* **Parameters:**
  **d** – a JSON dict
* **Returns:**
  a `BaseRunConfig`

#### *classmethod* from_json(path, \*args, \*\*kwargs)

Constructs a Serializable object from a JSON file.

Subclasses may override this method, but, by default, this method
simply reads the JSON and calls from_dict(), which subclasses must
implement.

* **Parameters:**
  * **path** – the path to the JSON file on disk
  * **\*args** – optional positional arguments for `self.from_dict()`
  * **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
  an instance of the Serializable class

#### *classmethod* from_kwargs(\*\*kwargs)

Constructs a Config object from keyword arguments.

* **Parameters:**
  **\*\*kwargs** – keyword arguments that define the fields expected by cls
* **Returns:**
  an instance of cls

#### *classmethod* from_str(s, \*args, \*\*kwargs)

Constructs a Serializable object from a JSON string.

Subclasses may override this method, but, by default, this method
simply parses the string and calls from_dict(), which subclasses must
implement.

* **Parameters:**
  * **s** – a JSON string representation of a Serializable object
  * **\*args** – optional positional arguments for `self.from_dict()`
  * **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
  an instance of the Serializable class

#### *classmethod* get_class_name()

Returns the fully-qualified class name string of this object.

#### load_credentials(\*\*kwargs)

Loads any necessary credentials from the given keyword arguments or
the relevant FiftyOne config.

* **Parameters:**
  **\*\*kwargs** – subclass-specific credentials

#### *classmethod* load_default()

Loads the default config instance from file.

Subclasses must implement this method if they intend to support
default instances.

#### *property* method

The name of the method.

#### *static* parse_array(d, key, default=<eta.core.config.NoDefault object>)

Parses a raw array attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default list to return if key is not present
* **Returns:**
  a list of raw (untouched) values
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_bool(d, key, default=<eta.core.config.NoDefault object>)

Parses a boolean value.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default bool to return if key is not present
* **Returns:**
  True/False
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_categorical(d, key, choices, default=<eta.core.config.NoDefault object>)

Parses a categorical JSON field, which must take a value from among
the given choices.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **choices** – either an iterable of possible values or an enum-like
    class whose attributes define the possible values
  * **default** – a default value to return if key is not present
* **Returns:**
  the raw (untouched) value of the given field, which is equal to a
  value from `choices`
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the key was present in the dictionary but its value
      was not an allowed choice, or if no default value was provided
      and the key was not found in the dictionary

#### *static* parse_dict(d, key, default=<eta.core.config.NoDefault object>)

Parses a dictionary attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default dict to return if key is not present
* **Returns:**
  a dictionary
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_int(d, key, default=<eta.core.config.NoDefault object>)

Parses an integer attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default integer value to return if key is not present
* **Returns:**
  an int
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_mutually_exclusive_fields(fields)

Parses a mutually exclusive dictionary of pre-parsed fields, which
must contain exactly one field with a truthy value.

* **Parameters:**
  **fields** – a dictionary of pre-parsed fields
* **Returns:**
  the (field, value) that was set
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if zero or more than one truthy value was found

#### *static* parse_number(d, key, default=<eta.core.config.NoDefault object>)

Parses a number attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default numeric value to return if key is not present
* **Returns:**
  a number (e.g. int, float)
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_object(d, key, cls, default=<eta.core.config.NoDefault object>)

Parses an object attribute.

The value of d[key] can be either an instance of cls or a serialized
dict from an instance of cls.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **cls** – the class of d[key]
  * **default** – a default cls instance to return if key is not present
* **Returns:**
  an instance of cls
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_object_array(d, key, cls, default=<eta.core.config.NoDefault object>)

Parses an array of objects.

The values in d[key] can be either instances of cls or serialized
dicts from instances of cls.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **cls** – the class of the elements of list d[key]
  * **default** – the default list to return if key is not present
* **Returns:**
  a list of cls instances
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_object_dict(d, key, cls, default=<eta.core.config.NoDefault object>)

Parses a dictionary whose values are objects.

The values in d[key] can be either instances of cls or serialized
dicts from instances of cls.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **cls** – the class of the values of dictionary d[key]
  * **default** – the default dict of cls instances to return if key is not
    present
* **Returns:**
  a dictionary whose values are cls instances
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_path(d, key, default=<eta.core.config.NoDefault object>)

Parses a path attribute.

The path is converted to an absolute path if necessary via
`os.path.abspath(os.path.expanduser(value))`.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default string to return if key is not present
* **Returns:**
  a path string
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *static* parse_raw(d, key, default=<eta.core.config.NoDefault object>)

Parses a raw (arbitrary) JSON field.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default value to return if key is not present
* **Returns:**
  the raw (untouched) value of the given field
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if no default value was provided and the key was not
      found in the dictionary

#### *static* parse_string(d, key, default=<eta.core.config.NoDefault object>)

Parses a string attribute.

* **Parameters:**
  * **d** – a JSON dictionary
  * **key** – the key to parse
  * **default** – a default string to return if key is not present
* **Returns:**
  a string
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
      value was provided and the key was not found in the dictionary

#### *property* run_cls

The `BaseRun` class associated with this config.

#### serialize(reflective=False)

Serializes the object into a dictionary.

Serialization is applied recursively to all attributes in the object,
including element-wise serialization of lists and dictionary values.

* **Parameters:**
  **reflective** – whether to include reflective attributes when
  serializing the object. By default, this is False
* **Returns:**
  a JSON dictionary representation of the object

#### to_str(pretty_print=True, \*\*kwargs)

Returns a string representation of this object.

* **Parameters:**
  * **pretty_print** – whether to render the JSON in human readable format
    with newlines and indentations. By default, this is True
  * **\*\*kwargs** – optional keyword arguments for `self.serialize()`
* **Returns:**
  a string representation of the object

#### *static* validate_all_or_nothing_fields(fields)

Validates a dictionary of pre-parsed fields checking that either
all or none of the fields have a truthy value.

* **Parameters:**
  **fields** – a dictionary of pre-parsed fields
* **Raises:**
  [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if some values are truth and some are not

#### write_json(path, pretty_print=False, \*\*kwargs)

Serializes the object and writes it to disk.

* **Parameters:**
  * **path** – the output path
  * **pretty_print** – whether to render the JSON in human readable format
    with newlines and indentations. By default, this is False
  * **\*\*kwargs** – optional keyword arguments for `self.serialize()`

### *class* fiftyone.utils.eval.SegmentationResults(samples, config, eval_key, pixel_confusion_matrix, classes, matches=None, missing=None, custom_metrics=None, backend=None)

Bases: [`BaseClassificationResults`](fiftyone.utils.eval.base.md#fiftyone.utils.eval.base.BaseClassificationResults)

Class that stores the results of a segmentation evaluation.

* **Parameters:**
  * **samples** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) used
  * **config** – the [`SegmentationEvaluationConfig`](#fiftyone.utils.eval.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** (*None*) – a list of
    `(gt_label, pred_label, pixel_count, gt_id, pred_id)`
    matches
  * **missing** (*None*) – a missing (background) class
  * **custom_metrics** (*None*) – an optional dict of custom metrics
  * **backend** (*None*) – a `SegmentationEvaluation` backend

**Methods:**

| [`dice_score`](#fiftyone.utils.eval.SegmentationResults.dice_score)()                                            | Computes the Dice score across all samples in the evaluation.                                                                                                                                                                          |
|------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`add_custom_metrics`](#fiftyone.utils.eval.SegmentationResults.add_custom_metrics)(custom_metrics[, overwrite]) | Computes the given custom metrics and adds them to these results.                                                                                                                                                                      |
| [`attributes`](#fiftyone.utils.eval.SegmentationResults.attributes)()                                            | Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.utils.eval.SegmentationResults.serialize).                                                                                                   |
| [`base_results_cls`](#fiftyone.utils.eval.SegmentationResults.base_results_cls)(type)                            | Returns the results class for the given run type.                                                                                                                                                                                      |
| [`clear_subset`](#fiftyone.utils.eval.SegmentationResults.clear_subset)()                                        | Clears the subset set by [`use_subset()`](#fiftyone.utils.eval.SegmentationResults.use_subset), if any.                                                                                                                                |
| [`confusion_matrix`](#fiftyone.utils.eval.SegmentationResults.confusion_matrix)([classes, include_other, ...])   | Generates a confusion matrix for the results via [`sklearn.metrics.confusion_matrix()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html#sklearn.metrics.confusion_matrix).                     |
| [`copy`](#fiftyone.utils.eval.SegmentationResults.copy)()                                                        | Returns a deep copy of the object.                                                                                                                                                                                                     |
| [`custom_attributes`](#fiftyone.utils.eval.SegmentationResults.custom_attributes)([dynamic, private])            | Returns a customizable list of class attributes.                                                                                                                                                                                       |
| [`from_dict`](#fiftyone.utils.eval.SegmentationResults.from_dict)(d, samples, config, key)                       | Builds a `BaseRunResults` from a JSON dict representation of it.                                                                                                                                                                       |
| [`from_json`](#fiftyone.utils.eval.SegmentationResults.from_json)(path, \*args, \*\*kwargs)                      | Constructs a Serializable object from a JSON file.                                                                                                                                                                                     |
| [`from_str`](#fiftyone.utils.eval.SegmentationResults.from_str)(s, \*args, \*\*kwargs)                           | Constructs a Serializable object from a JSON string.                                                                                                                                                                                   |
| [`get_class_name`](#fiftyone.utils.eval.SegmentationResults.get_class_name)()                                    | Returns the fully-qualified class name string of this object.                                                                                                                                                                          |
| [`get_meta`](#fiftyone.utils.eval.SegmentationResults.get_meta)()                                                | Small facts that DESCRIBE these results, stored beside the run so callers can read them without loading the results.                                                                                                                   |
| [`metrics`](#fiftyone.utils.eval.SegmentationResults.metrics)([classes, average, beta])                          | Computes classification metrics for the results, including accuracy, precision, recall, and F-beta score.                                                                                                                              |
| [`plot_confusion_matrix`](#fiftyone.utils.eval.SegmentationResults.plot_confusion_matrix)([classes, ...])        | Plots a confusion matrix for the evaluation results.                                                                                                                                                                                   |
| [`print_metrics`](#fiftyone.utils.eval.SegmentationResults.print_metrics)([classes, average, beta, digits])      | Prints the metrics computed via [`metrics()`](#fiftyone.utils.eval.SegmentationResults.metrics).                                                                                                                                       |
| [`print_report`](#fiftyone.utils.eval.SegmentationResults.print_report)([classes, digits])                       | Prints a classification report for the results via [`sklearn.metrics.classification_report()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.classification_report.html#sklearn.metrics.classification_report).    |
| [`report`](#fiftyone.utils.eval.SegmentationResults.report)([classes])                                           | Generates a classification report for the results via [`sklearn.metrics.classification_report()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.classification_report.html#sklearn.metrics.classification_report). |
| [`save`](#fiftyone.utils.eval.SegmentationResults.save)()                                                        | Saves the results to the database.                                                                                                                                                                                                     |
| [`save_config`](#fiftyone.utils.eval.SegmentationResults.save_config)()                                          | Saves these results config to the database.                                                                                                                                                                                            |
| [`serialize`](#fiftyone.utils.eval.SegmentationResults.serialize)([reflective])                                  | Serializes the object into a dictionary.                                                                                                                                                                                               |
| [`to_str`](#fiftyone.utils.eval.SegmentationResults.to_str)([pretty_print])                                      | Returns a string representation of this object.                                                                                                                                                                                        |
| [`use_subset`](#fiftyone.utils.eval.SegmentationResults.use_subset)(subset_def)                                  | Restricts the evaluation results to the specified subset.                                                                                                                                                                              |
| [`write_json`](#fiftyone.utils.eval.SegmentationResults.write_json)(path[, pretty_print])                        | Serializes the object and writes it to disk.                                                                                                                                                                                           |

**Attributes:**

| [`backend`](#fiftyone.utils.eval.SegmentationResults.backend)       | The `BaseRun` for these results.                                                                                                                           |
|---------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`cls`](#fiftyone.utils.eval.SegmentationResults.cls)               | The fully-qualified name of this `BaseRunResults` class.                                                                                                   |
| [`config`](#fiftyone.utils.eval.SegmentationResults.config)         | The `BaseRunConfig` for these results.                                                                                                                     |
| [`has_subset`](#fiftyone.utils.eval.SegmentationResults.has_subset) | Whether these results are currently restricted to a subset via [`use_subset()`](#fiftyone.utils.eval.SegmentationResults.use_subset).                      |
| [`key`](#fiftyone.utils.eval.SegmentationResults.key)               | The run key for these results.                                                                                                                             |
| [`samples`](#fiftyone.utils.eval.SegmentationResults.samples)       | The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) associated with these results. |

#### dice_score()

Computes the Dice score across all samples in the evaluation.

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

#### add_custom_metrics(custom_metrics, overwrite=True)

Computes the given custom metrics and adds them to these results.

* **Parameters:**
  * **custom_metrics** – a list of custom metrics to compute or a dict
    mapping metric names to kwargs dicts
  * **overwrite** (*True*) – whether to recompute any custom metrics that
    have already been applied

#### attributes()

Returns the list of class attributes that will be serialized by
[`serialize()`](#fiftyone.utils.eval.SegmentationResults.serialize).

* **Returns:**
  a list of attributes

#### *property* backend

The `BaseRun` for these results.

#### *static* base_results_cls(type)

Returns the results class for the given run type.

* **Parameters:**
  **type** – a `BaseRunConfig.type`
* **Returns:**
  a `BaseRunResults` subclass

#### clear_subset()

Clears the subset set by [`use_subset()`](#fiftyone.utils.eval.SegmentationResults.use_subset), if any.

Subsequent operations will be performed on the full results.

#### *property* cls

The fully-qualified name of this `BaseRunResults` class.

#### *property* config

The `BaseRunConfig` for these results.

#### confusion_matrix(classes=None, include_other=False, include_missing=False)

Generates a confusion matrix for the results via
[`sklearn.metrics.confusion_matrix()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html#sklearn.metrics.confusion_matrix).

The rows of the confusion matrix represent ground truth and the columns
represent predictions.

* **Parameters:**
  * **classes** (*None*) – an optional list of classes to include in the
    confusion matrix
  * **include_other** (*False*) – whether to include an extra row/column at
    the end of the matrix for labels that do not appear in
    `classes`. Only applicable if `classes` are provided
  * **include_missing** (*False*) – whether to include a row/column at the end
    of the matrix for unmatched labels. Only applicable if
    `self.missing` does not already appear in `classes`. If
    both “other” and “missing” rows/columns are requested, this one
    is last
* **Returns:**
  a `num_classes x num_classes` confusion matrix

#### copy()

Returns a deep copy of the object.

* **Returns:**
  a Serializable instance

#### custom_attributes(dynamic=False, private=False)

Returns a customizable list of class attributes.

By default, all attributes in vars(self) are returned, minus private
attributes (those starting with “_”).

* **Parameters:**
  * **dynamic** – whether to include dynamic properties, e.g., those defined
    by getter/setter methods or the `@property` decorator. By
    default, this is False
  * **private** – whether to include private properties, i.e., those
    starting with “_”. By default, this is False
* **Returns:**
  a list of class attributes

#### *classmethod* from_dict(d, samples, config, key)

Builds a `BaseRunResults` from a JSON dict representation of
it.

* **Parameters:**
  * **d** – a JSON dict
  * **samples** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
    for the run
  * **config** – the `BaseRunConfig` for the run
  * **key** – the run key
* **Returns:**
  a `BaseRunResults`

#### *classmethod* from_json(path, \*args, \*\*kwargs)

Constructs a Serializable object from a JSON file.

Subclasses may override this method, but, by default, this method
simply reads the JSON and calls from_dict(), which subclasses must
implement.

* **Parameters:**
  * **path** – the path to the JSON file on disk
  * **\*args** – optional positional arguments for `self.from_dict()`
  * **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
  an instance of the Serializable class

#### *classmethod* from_str(s, \*args, \*\*kwargs)

Constructs a Serializable object from a JSON string.

Subclasses may override this method, but, by default, this method
simply parses the string and calls from_dict(), which subclasses must
implement.

* **Parameters:**
  * **s** – a JSON string representation of a Serializable object
  * **\*args** – optional positional arguments for `self.from_dict()`
  * **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
  an instance of the Serializable class

#### *classmethod* get_class_name()

Returns the fully-qualified class name string of this object.

#### get_meta()

Small facts that DESCRIBE these results, stored beside the run so
callers can read them without loading the results.

The results themselves are a blob in GridFS whose arrays can run to
hundreds of MB; a count or a path is a few bytes. Anything returned
here is written when the results are saved (see
`BaseRun.save_run_results()`), so no read path has to load — or
write — to answer for it.

* **Returns:**
  a JSON-serializable dict

#### *property* has_subset

Whether these results are currently restricted to a subset via
[`use_subset()`](#fiftyone.utils.eval.SegmentationResults.use_subset).

#### *property* key

The run key for these results.

#### metrics(classes=None, average='micro', beta=1.0)

Computes classification metrics for the results, including accuracy,
precision, recall, and F-beta score.

See [`sklearn.metrics.precision_recall_fscore_support()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.precision_recall_fscore_support.html#sklearn.metrics.precision_recall_fscore_support) for
details.

Also includes any custom metrics from `custom_metrics`.

* **Parameters:**
  * **classes** (*None*) – an optional list of classes to include in the
    calculations
  * **average** ( *"micro"*) – the averaging strategy to use
  * **beta** (*1.0*) – the F-beta value to use
* **Returns:**
  a dict

#### plot_confusion_matrix(classes=None, include_other=None, include_missing=None, other_label='(other)', backend='plotly', \*\*kwargs)

Plots a confusion matrix for the evaluation results.

If you are working in a notebook environment with the default plotly
backend, this method returns an interactive
[`fiftyone.core.plots.plotly.InteractiveHeatmap`](fiftyone.core.plots.plotly.md#fiftyone.core.plots.plotly.InteractiveHeatmap) that you can
attach to an App session via its
[`fiftyone.core.session.Session.plots`](fiftyone.core.session.md#fiftyone.core.session.Session.plots) attribute, which will
automatically sync the session’s view with the currently selected cells
in the confusion matrix.

* **Parameters:**
  * **classes** (*None*) – an optional list of classes to include in the
    confusion matrix
  * **include_other** (*None*) – 

    whether to include a row/column for examples
    whose label is in `classes` but are matched to labels that
    do not appear in `classes`. Only applicable if `classes`
    are provided. The supported values are:
    - None (default): only include a row/column for other labels
      if there are any
    - True: do include a row/column for other labels
    - False: do not include a row/column for other labels
  * **include_missing** (*None*) – 

    whether to include a row/column for missing
    ground truth/predictions in the confusion matrix. The supported
    values are:
    - None (default): only include a row/column for missing
      labels if there are any
    - True: do include a row/column for missing labels
    - False: do not include a row/column for missing labels
  * **other_label** ( *"* *(**other* *)* *"*) – the label to use for “other” predictions
  * **backend** ( *"plotly"*) – the plotting backend to use. Supported values
    are `("plotly", "matplotlib")`
  * **\*\*kwargs** – 

    keyword arguments for the backend plotting method:
    - ”plotly” backend: [`fiftyone.core.plots.plotly.plot_confusion_matrix()`](fiftyone.core.plots.plotly.md#fiftyone.core.plots.plotly.plot_confusion_matrix)
    - ”matplotlib” backend: [`fiftyone.core.plots.matplotlib.plot_confusion_matrix()`](fiftyone.core.plots.matplotlib.md#fiftyone.core.plots.matplotlib.plot_confusion_matrix)
* **Returns:**
  - a [`fiftyone.core.plots.plotly.InteractiveHeatmap`](fiftyone.core.plots.plotly.md#fiftyone.core.plots.plotly.InteractiveHeatmap), if
    the plotly backend is used
  - a matplotlib figure, otherwise
* **Return type:**
  one of the following

#### print_metrics(classes=None, average='micro', beta=1.0, digits=2)

Prints the metrics computed via [`metrics()`](#fiftyone.utils.eval.SegmentationResults.metrics).

* **Parameters:**
  * **classes** (*None*) – an optional list of classes to include in the
    calculations
  * **average** ( *"micro"*) – the averaging strategy to use
  * **beta** (*1.0*) – the F-beta value to use
  * **digits** (*2*) – the number of digits of precision to print

#### print_report(classes=None, digits=2)

Prints a classification report for the results via
[`sklearn.metrics.classification_report()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.classification_report.html#sklearn.metrics.classification_report).

* **Parameters:**
  * **classes** (*None*) – an optional list of classes to include in the
    report
  * **digits** (*2*) – the number of digits of precision to print

#### report(classes=None)

Generates a classification report for the results via
[`sklearn.metrics.classification_report()`](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.classification_report.html#sklearn.metrics.classification_report).

* **Parameters:**
  **classes** (*None*) – an optional list of classes to include in the
  report
* **Returns:**
  a dict

#### *property* samples

The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) associated
with these results.

#### save()

Saves the results to the database.

#### save_config()

Saves these results config to the database.

#### serialize(reflective=False)

Serializes the object into a dictionary.

Serialization is applied recursively to all attributes in the object,
including element-wise serialization of lists and dictionary values.

* **Parameters:**
  **reflective** – whether to include reflective attributes when
  serializing the object. By default, this is False
* **Returns:**
  a JSON dictionary representation of the object

#### to_str(pretty_print=True, \*\*kwargs)

Returns a string representation of this object.

* **Parameters:**
  * **pretty_print** – whether to render the JSON in human readable format
    with newlines and indentations. By default, this is True
  * **\*\*kwargs** – optional keyword arguments for `self.serialize()`
* **Returns:**
  a string representation of the object

#### use_subset(subset_def)

Restricts the evaluation results to the specified subset.

Subsequent calls to supported methods on this instance will only
contain results from the specified subset rather than the full results.

Use [`clear_subset()`](#fiftyone.utils.eval.SegmentationResults.clear_subset) to reset to the full results. Or,
equivalently, use the context manager interface as demonstrated below
to automatically reset the results when the context exits.

Example usage:

```default
import fiftyone as fo
import fiftyone.zoo as foz
import fiftyone.utils.random as four
from fiftyone import ViewField as F

dataset = foz.load_zoo_dataset("quickstart")
four.random_split(dataset, {"sunny": 0.7, "cloudy": 0.2, "rainy": 0.1})

results = dataset.evaluate_detections(
    "predictions",
    gt_field="ground_truth",
    eval_key="eval",
)

counts = dataset.count_values("ground_truth.detections.label")
classes = sorted(counts, key=counts.get, reverse=True)[:5]

# Full results
results.print_report(classes=classes)

# Sunny samples
subset_def = dict(type="field", field="tags", value="sunny")
with results.use_subset(subset_def):
    results.print_report(classes=classes)

# Small objects
bbox_area = F("bounding_box")[2] * F("bounding_box")[3]
small_objects = bbox_area <= 0.05
subset_def = dict(type="attribute", expr=small_objects)
with results.use_subset(subset_def):
    results.print_report(classes=classes)
```

* **Parameters:**
  **subset_def** – 

  the subset definition, which can be:
  - a dict or list of dicts defining the subset. See above
    for examples and see [`get_subset_view()`](#fiftyone.utils.eval.get_subset_view) for full
    syntax
  - a [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView) defining the
    subset
* **Returns:**
  self

#### write_json(path, pretty_print=False, \*\*kwargs)

Serializes the object and writes it to disk.

* **Parameters:**
  * **path** – the output path
  * **pretty_print** – whether to render the JSON in human readable format
    with newlines and indentations. By default, this is False
  * **\*\*kwargs** – optional keyword arguments for `self.serialize()`
