langtest.transform.robustness.AddPunctuation#

class AddPunctuation#

Bases: BaseRobustness

A class for adding punctuation to 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, whitelist, count])	Add punctuation at the end of the string, if there is punctuation at the end skip it

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, whitelist: List[str] | None = None, count: int = 1) → List[Sample]#

Add punctuation at the end of the string, if there is punctuation at the end skip it

Parameters:

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

• prob (Optional[float]) – The probability of adding punctuation to each sample. Defaults to 1.0, which means all words will be transformed.

• whitelist (Optional[List[str]]) – A list of punctuation characters to consider when adding punctuation. If None, the default whitelist [‘!’, ‘?’, ‘,’, ‘.’, ‘-’, ‘:’, ‘;’] will be used. Defaults to None.

• count – Number of variations to create.

Returns:

The transformed sample list with added punctuation.

Return type:

List[Sample]