langtest.transform.robustness.SwapEntities#

class SwapEntities#

Bases: BaseRobustness

A class for swapping entities in text samples.

__init__()#

Methods

__init__()

async_run(sample_list, model, **kwargs)

Creates a task to run the robustness measure.

run(sample_list, model, **kwargs)

Abstract method that implements the robustness measure.

transform(sample_list[, prob, labels, ...])

Swap entities in the text samples of the given sample list.

Attributes

alias_name

supported_tasks

test_types

async classmethod async_run(sample_list: List[Sample], model: ModelAPI, **kwargs)#

Creates a task to run the robustness measure.

Parameters:

  • sample_list (List[Sample]) – The input data to be transformed.

  • model (ModelAPI) – The model to be used for evaluation.

  • **kwargs – Additional arguments to be passed to the robustness measure.

Returns:

The task that runs the robustness measure.

Return type:

asyncio.Task

abstract async static run(sample_list: List[Sample], model: ModelAPI, **kwargs) → List[Sample]#

Abstract method that implements the robustness measure.

Parameters:

  • sample_list (List[Sample]) – The input data to be transformed.

  • model (ModelAPI) – The model to be used for evaluation.

  • **kwargs – Additional arguments to be passed to the robustness measure.

Returns:

The transformed data based on the implemented robustness measure.

Return type:

List[Sample]

static transform(sample_list: List[Sample], prob: float | None = 1.0, labels: List[List[str]] | None = None, terminology: Dict[str, List[str]] | None = None, count: int = 1) → List[Sample]#

Swap entities in the text samples of the given sample list.

Parameters:

  • sample_list (List[Sample]) – A list of samples to be transformed.

  • prob (Optional[float]) – The probability of swapping entities in each sample. Defaults to 1.0, which means all eligible samples will have their entities swapped.

  • labels (List[List[str]]) – Corresponding labels to make changes according to sentences.

  • terminology (Dict[str, List[str]]) – Dictionary of entities and corresponding list of words.

Returns:

The transformed sample list with entities swapped.

Return type:

List[Sample]