📄 From Pair¶

tasks.generation.from_pair

Task(
    input_fields={
        "input_a": "Union[Text, Image, Audio, Table, Dialog]",
        "type_of_input_a": "str",
        "input_b": "Union[Text, Image, Audio, Table, Dialog]",
        "type_of_input_b": "str",
        "type_of_output": "str",
    },
    reference_fields={
        "output": "str",
    },
    prediction_type="str",
    metrics=[
        "metrics.rouge",
        "metrics.bert_score.bert_base_uncased",
        "metrics.bleu",
        "metrics.meteor",
    ],
    augmentable_inputs=[
        "input_a",
        "input_b",
    ],
    defaults={
        "type_of_output": "Text",
    },
)
[source]

Explanation about Task¶

Task packs the different instance fields into dictionaries by their roles in the task.

Args:

input_fields (Union[Dict[str, str], List[str]]):
Dictionary with string names of instance input fields and types of respective values. In case a list is passed, each type will be assumed to be Any.

reference_fields (Union[Dict[str, str], List[str]]):
Dictionary with string names of instance output fields and types of respective values. In case a list is passed, each type will be assumed to be Any.

metrics (List[str]):
List of names of metrics to be used in the task.

prediction_type (Optional[str]):
Need to be consistent with all used metrics. Defaults to None, which means that it will be set to Any.

defaults (Optional[Dict[str, Any]]):
An optional dictionary with default values for chosen input/output keys. Needs to be consistent with names and types provided in ‘input_fields’ and/or ‘output_fields’ arguments. Will not overwrite values if already provided in a given instance.

The output instance contains three fields:

“input_fields” whose value is a sub-dictionary of the input instance, consisting of all the fields listed in Arg ‘input_fields’.

“reference_fields” – for the fields listed in Arg “reference_fields”.

“metrics” – to contain the value of Arg ‘metrics’

References: metrics.bert_score.bert_base_uncased, metrics.meteor, metrics.rouge, metrics.bleu