quantus.helpers.constants module

This module contains constants and simple methods to retreive the available metrics, perturbation-, similarity-, normalisation- functions and explanation methods in Quantus.

quantus.helpers.constants.available_categories() → List[str]

Retrieve the available metric categories in Quantus.

Returns:

List[str]

With the available metric categories in Quantus.

quantus.helpers.constants.available_methods_captum() → List[str]

Retrieve the available explanation methods in Quantus.

Returns:

List[str]

With the available explanation methods in Quantus.

quantus.helpers.constants.available_methods_tf_explain() → List[str]

Retrieve the available explanation methods in Quantus.

Returns:

List[str]

With the available explanation methods in Quantus.

quantus.helpers.constants.available_metrics() → Dict[str, List[str]]

Retrieve the available metrics in Quantus.

Returns:

Dict[str, str]

With the available metrics, under each category in Quantus.

quantus.helpers.constants.available_normalisation_functions() → List[str]

Retrieve the available normalisation functions in Quantus.

Returns:

List[str]

With the available normalisation functions in Quantus.

quantus.helpers.constants.available_perturbation_functions() → List[str]

Retrieve the available perturbation functions in Quantus.

Returns:

List[str]

With the available perturbation functions in Quantus.

quantus.helpers.constants.available_similarity_functions() → List[str]

Retrieve the available similarity functions in Quantus.

Returns:

List[str]

With the available similarity functions in Quantus.