langtest.transform.sensitivity.SensitivityTestFactory#

class SensitivityTestFactory(data_handler: List[Sample], tests: Dict | None = None, **kwargs)#

Bases: ITests

A class for performing Sensitivity tests on a given dataset.

This class provides functionality to perform sensitivity tests on a given dataset using various test configurations.

alias_name#

A string representing the alias name for this test factory.

Type:

str

__init__(data_handler: List[Sample], tests: Dict | None = None, **kwargs) None#

Initialize a new SensitivityTestFactory instance.

Parameters:
  • data_handler (List[Sample]) – A list of Sample objects representing the input dataset.

  • tests (Optional[Dict]) – A dictionary of test names and corresponding parameters (default is None).

  • **kwargs – Additional keyword arguments.

Raises:

ValueError – If the tests argument is not a dictionary.

Methods

__init__(data_handler[, tests])

Initialize a new SensitivityTestFactory instance.

available_tests()

Get a dictionary of all available tests, with their names as keys and their corresponding classes as values.

run(sample_list, model, **kwargs)

Runs the specified tests on the given data and returns a list of results.

transform()

Run the sensitivity test and return the resulting Sample objects.

Attributes

alias_name

static available_tests() dict#

Get a dictionary of all available tests, with their names as keys and their corresponding classes as values.

Returns:

A dictionary of test names and classes.

Return type:

dict

classmethod run(sample_list: Dict[str, List[Sample]], model: ModelAPI, **kwargs) List[Sample]#

Runs the specified tests on the given data and returns a list of results.

Parameters:
  • sample_list (Dict[str, List[Sample]]) – A dictionary mapping test scenario names to a list of Sample objects.

  • model (ModelAPI) – A ModelAPI object representing the model to be tested.

Returns:

A list of Sample objects with the test results.

Return type:

List[Sample]

transform() List[Sample]#

Run the sensitivity test and return the resulting Sample objects.

Returns:

A list of Sample objects representing the resulting dataset after running the sensitivity test.

Return type:

List[Sample]