nucleus.validate.eval_functions.available_eval_functions¶

`AvailableEvalFunctions`	Collection class that acts as a common entrypoint to access evaluation functions. Standard evaluation functions
`BoundingBoxIOUConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`BoundingBoxMAPConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`BoundingBoxPrecisionConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`BoundingBoxRecallConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`CategorizationF1Config`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`CuboidIOU2DConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`CuboidIOU3DConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`CuboidPrecisionConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`CuboidRecallConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`CustomEvalFunction`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`EvalFunctionNotAvailable`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`ExternalEvalFunction`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`PolygonIOUConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`PolygonMAPConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`PolygonPrecisionConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`PolygonRecallConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`SegmentationToPolyAveragePrecisionConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`SegmentationToPolyIOUConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`SegmentationToPolyMAPConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`SegmentationToPolyPrecisionConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`SegmentationToPolyRecallConfig`	Abstract base class for concrete implementations of EvalFunctionsConfigs
`StandardEvalFunction`	Class for standard Model CI eval functions that have not been added as attributes on

class nucleus.validate.eval_functions.available_eval_functions.AvailableEvalFunctions(available_functions)¶

Collection class that acts as a common entrypoint to access evaluation functions. Standard evaluation functions provided by Scale are attributes of this class.

The available evaluation functions are listed in the sample below:

e = client.validate.eval_functions
unit_test_criteria = [
    e.bbox_iou() > 5,
    e.bbox_map() > 0.95,
    e.bbox_precision() > 0.8,
    e.bbox_recall() > 0.5,
]

Parameters:: available_functions (List[nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry])

class nucleus.validate.eval_functions.available_eval_functions.BoundingBoxIOUConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.BoundingBoxMAPConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.BoundingBoxPrecisionConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.BoundingBoxRecallConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.CategorizationF1Config(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.CuboidIOU2DConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.CuboidIOU3DConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.CuboidPrecisionConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.CuboidRecallConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.CustomEvalFunction(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

abstract classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.EvalFunctionNotAvailable(not_available_name)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: not_available_name (str)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.ExternalEvalFunction(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.PolygonIOUConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.PolygonMAPConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.PolygonPrecisionConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.PolygonRecallConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.SegmentationToPolyAveragePrecisionConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.SegmentationToPolyIOUConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.SegmentationToPolyMAPConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.SegmentationToPolyPrecisionConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.SegmentationToPolyRecallConfig(eval_func_entry)¶

Abstract base class for concrete implementations of EvalFunctionsConfigs

Operating on this class with comparison operators produces an EvaluationCriterion

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str

class nucleus.validate.eval_functions.available_eval_functions.StandardEvalFunction(eval_func_entry)¶

Class for standard Model CI eval functions that have not been added as attributes on AvailableEvalFunctions yet.

Parameters:: eval_func_entry (nucleus.validate.data_transfer_objects.eval_function.EvalFunctionEntry)

classmethod expected_name()¶

Name to look for in the EvalFunctionDefinitions

Return type:: str