otx.api.entities.explain_parameters#

This module define the Explain entity.

Functions

default_progress_callback(progress[, score])

This is the default progress callback for OptimizationParameters.

Classes

ExplainParameters(update_progress, ...)

Explain parameters.

class otx.api.entities.explain_parameters.ExplainParameters(update_progress: ~typing.Callable[[int, float | None], ~typing.Any] = <function default_progress_callback>, explainer: str = '', process_saliency_maps: bool = False, explain_predicted_classes: bool = True)[source]#

Bases: object

Explain parameters.

explainer#

Explain algorithm to be used in explanation mode. Will be converted automatically to lowercase.

Type:: str

process_saliency_maps#

Processing of saliency map includes (1) resize to input image resolution and (2) apply a colormap.

Type:: bool

explain_predicted_classes#

Provides explanations only for predicted classes. Otherwise, explain all classes.

Type:: bool

update_progress(score: float | None = None)#: This is the default progress callback for OptimizationParameters.

otx.api.entities.explain_parameters.default_progress_callback(progress: int, score: float | None = None)[source]#: This is the default progress callback for OptimizationParameters.