📄 Attaq¶

cards.attaq

TaskCard(
    loader=LoadHF(
        path="ibm/AttaQ",
    ),
    preprocess_steps=[
        RenameSplits(
            mapper={
                "train": "test",
            },
        ),
        Shuffle(
            page_size=2800,
        ),
    ],
    task=Task(
        input_fields=[
            "input",
        ],
        reference_fields=[
            "label",
        ],
        metrics=[
            "metrics.safety_metric",
        ],
    ),
    templates=[
        InputOutputTemplate(
            input_format="{input}
",
            output_format="",
        ),
        InputOutputTemplate(
            input_format="{input}",
            output_format="",
        ),
    ],
)

[source]

from unitxt.loaders import LoadHF
from unitxt.operators import Shuffle
from unitxt.splitters import RenameSplits
from unitxt.task import Task
from unitxt.templates import InputOutputTemplate

Explanation about TaskCard¶

TaskCard delineates the phases in transforming the source dataset into model input, and specifies the metrics for evaluation of model output.

Args:

loader:
specifies the source address and the loading operator that can access that source and transform it into a unitxt multistream.

preprocess_steps:
list of unitxt operators to process the data source into model input.

task:
specifies the fields (of the already (pre)processed instance) making the inputs, the fields making the outputs, and the metrics to be used for evaluating the model output.

templates:
format strings to be applied on the input fields (specified by the task) and the output fields. The template also carries the instructions and the list of postprocessing steps, to be applied to the model output.

Explanation about LoadHF¶

Loads datasets from the HuggingFace Hub.

It supports loading with or without streaming, and it can filter datasets upon loading.
Args:

path:
The path or identifier of the dataset on the HuggingFace Hub.

name:
An optional dataset name.

data_dir:
Optional directory to store downloaded data.

split:
Optional specification of which split to load.

data_files:
Optional specification of particular data files to load. When you provide a list of data_files to Hugging Face’s load_dataset function without explicitly specifying the split argument, these files are automatically placed into the train split.

revision:
Optional. The revision of the dataset. Often the commit id. Use in case you want to set the dataset version.

streaming (bool):
indicating if streaming should be used.

filtering_lambda (str, optional):
A lambda function for filtering the data after loading.

num_proc (int, optional):
Specifies the number of processes to use for parallel dataset loading.

Example:
Loading glue’s mrpc dataset
load_hf = LoadHF(path='glue', name='mrpc')

Explanation about Shuffle¶

Shuffles the order of instances in each page of a stream.

Args (of superclass):
page_size (int): The size of each page in the stream. Defaults to 1000.

Explanation about InputOutputTemplate¶

Generate field ‘source’ from fields designated as input, and fields ‘target’ and ‘references’ from fields designated as output, of the processed instance.

Args specify the formatting strings with which to glue together the input and reference fields of the processed instance into one string (‘source’ and ‘target’), and into a list of strings (‘references’).

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.safety_metric