langtest.transform.representation.BaseRepresentation#

class BaseRepresentation#

Bases: ABC

Abstract base class for implementing representation measures.

alias_name#

A name or list of names that identify the representation measure.

Type:

str

supported_tasks#

name of the supported task for the representation measure

Type:

List[str]

transform(data

List[Sample]) -> Any: Transforms the input data into an output

based on the implemented representation measure.

__init__()#

Methods

__init__()
async_run(sample_list, model, **kwargs)	Creates a task for the run method.
run(sample_list, model, **kwargs)	Computes the score for the given data.
transform(test, data, params)	Abstract method that implements the representation measure.

Attributes

alias_name
supported_tasks
test_types

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

Creates a task for the run method.

Parameters:

• sample_list (List[Sample]) – The input data to be evaluated for representation test.

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

Returns:

The task for the run method.

Return type:

asyncio.Task

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

Computes the score for the given data.

Parameters:

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

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

Returns:

The transformed samples.

Return type:

List[Sample]

abstract classmethod transform(test: str, data: List[Sample], params: Dict) → List[MinScoreQASample] | List[MinScoreSample]#

Abstract method that implements the representation measure.

Parameters:

• test (str) – name of the test to perform

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

• params (Dict) – parameters for tests configuration

Returns:

The transformed data based on the implemented representation measure.

Return type:

Any