๐Ÿ“„ wiki_bioยถ

Note

ID: cards.wiki_bio | Type: TaskCard

{
    "loader": {
        "path": "wiki_bio",
        "type": "load_hf"
    },
    "preprocess_steps": [
        {
            "mix": {
                "test": "test",
                "train": "train",
                "validation": "val"
            },
            "type": "split_random_mix"
        },
        {
            "fields": [
                "input_text/table/column_header",
                "input_text/table/content"
            ],
            "to_field": "kvpairs",
            "type": "list_to_key_val_pairs"
        },
        {
            "field_to_field": [
                [
                    "kvpairs",
                    "input"
                ]
            ],
            "type": "serialize_key_val_pairs"
        },
        {
            "field_to_field": {
                "target_text": "output"
            },
            "type": "rename_fields"
        },
        {
            "fields": {
                "type_of_input": "Key-Value pairs",
                "type_of_output": "Text"
            },
            "type": "add_fields"
        }
    ],
    "task": "tasks.generation",
    "templates": "templates.generation.all",
    "type": "task_card"
}

Explanation about TaskCardยถ

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

Attributes:

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 a 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 ListToKeyValPairsยถ

Maps list of keys and values into key:value pairs.

Sample input in expected format: {โ€œkeysโ€: [โ€œnameโ€, โ€œageโ€, โ€œsexโ€], โ€œvaluesโ€: [โ€œAlexโ€, 31, โ€œMโ€]} Sample output: {โ€œnameโ€: โ€œAlexโ€, โ€œageโ€: 31, โ€œsexโ€: โ€œMโ€}

Explanation about RenameFieldsยถ

Renames fields.

Move value from one field to another, potentially, if field name contains a /, from one branch into another. Remove the from field, potentially part of it in case of / in from_field.

Examples:

RenameFields(field_to_field={โ€œbโ€: โ€œcโ€}) will change inputs [{โ€œaโ€: 1, โ€œbโ€: 2}, {โ€œaโ€: 2, โ€œbโ€: 3}] to [{โ€œaโ€: 1, โ€œcโ€: 2}, {โ€œaโ€: 2, โ€œcโ€: 3}]

RenameFields(field_to_field={โ€œbโ€: โ€œc/dโ€}) will change inputs [{โ€œaโ€: 1, โ€œbโ€: 2}, {โ€œaโ€: 2, โ€œbโ€: 3}] to [{โ€œaโ€: 1, โ€œcโ€: {โ€œdโ€: 2}}, {โ€œaโ€: 2, โ€œcโ€: {โ€œdโ€: 3}}]

RenameFields(field_to_field={โ€œbโ€: โ€œb/dโ€}) will change inputs [{โ€œaโ€: 1, โ€œbโ€: 2}, {โ€œaโ€: 2, โ€œbโ€: 3}] to [{โ€œaโ€: 1, โ€œbโ€: {โ€œdโ€: 2}}, {โ€œaโ€: 2, โ€œbโ€: {โ€œdโ€: 3}}]

RenameFields(field_to_field={โ€œb/c/eโ€: โ€œb/dโ€}) will change inputs [{โ€œaโ€: 1, โ€œbโ€: {โ€œcโ€: {โ€œeโ€: 2, โ€œfโ€: 20}}}] to [{โ€œaโ€: 1, โ€œbโ€: {โ€œcโ€: {โ€œfโ€: 20}, โ€œdโ€: 2}}]

Explanation about AddFieldsยถ

Adds specified fields to each instance in a given stream or all streams (default) If fields exist, updates them.

Args:
fields (Dict[str, object]): The fields to add to each instance.

Use โ€˜/โ€™ to access inner fields

use_deepcopy (bool) : Deep copy the input value to avoid later modifications

Examples:

# Add a โ€˜classesโ€™ field with a value of a list โ€œpositiveโ€ and โ€œnegativeโ€ to all streams AddFields(fields={โ€œclassesโ€: [โ€œpositiveโ€,โ€negativesโ€]})

# Add a โ€˜startโ€™ field under the โ€˜spanโ€™ field with a value of 0 to all streams AddFields(fields={โ€œspan/startโ€: 0}

# Add a โ€˜classesโ€™ field with a value of a list โ€œpositiveโ€ and โ€œnegativeโ€ to โ€˜trainโ€™ stream AddFields(fields={โ€œclassesโ€: [โ€œpositiveโ€,โ€negativesโ€], apply_to_stream=[โ€œtrainโ€]})

# Add a โ€˜classesโ€™ field on a given list, prevent modification of original list # from changing the instance. AddFields(fields={โ€œclassesโ€: alist}), use_deepcopy=True) # if now alist is modified, still the instances remain intact.

Explanation about SerializeKeyValPairsยถ

Serializes key, value pairs into a flat sequence.

Sample input in expected format: {โ€œnameโ€: โ€œAlexโ€, โ€œageโ€: 31, โ€œsexโ€: โ€œMโ€} Sample output: name is Alex, age is 31, sex is M

Explanation about SplitRandomMixยถ

Splits a multistream into new streams (splits), whose names, source input stream, and amount of instances, are specified by arg โ€˜mixโ€™.

The keys of arg โ€˜mixโ€™, are the names of the new streams, the values are of the form: โ€˜name-of-source-stream[percentage-of-source-stream]โ€™ Each input instance, of any input stream, is selected exactly once for inclusion in any of the output streams.

Examples: When processing a multistream made of two streams whose names are โ€˜trainโ€™ and โ€˜testโ€™, by SplitRandomMix(mix = { โ€œtrainโ€: โ€œtrain[99%]โ€, โ€œvalidationโ€: โ€œtrain[1%]โ€, โ€œtestโ€: โ€œtestโ€ }) the output is a multistream, whose three streams are named โ€˜trainโ€™, โ€˜validationโ€™, and โ€˜testโ€™. Output stream โ€˜trainโ€™ is made of randomly selected 99% of the instances of input stream โ€˜trainโ€™, output stream โ€˜validationโ€™ is made of the remaining 1% instances of input โ€˜trainโ€™, and output stream โ€˜testโ€™ is made of the whole of input stream โ€˜testโ€™.

When processing the above input multistream by SplitRandomMix(mix = { โ€œtrainโ€: โ€œtrain[50%]+test[0.1]โ€, โ€œvalidationโ€: โ€œtrain[50%]+test[0.2]โ€, โ€œtestโ€: โ€œtest[0.7]โ€ }) the output is a multistream, whose three streams are named โ€˜trainโ€™, โ€˜validationโ€™, and โ€˜testโ€™. Output stream โ€˜trainโ€™ is made of randomly selected 50% of the instances of input stream โ€˜trainโ€™ + randomly selected 0.1 (i.e., 10%) of the instances of input stream โ€˜testโ€™. Output stream โ€˜validationโ€™ is made of the remaining 50% instances of input โ€˜trainโ€™+ randomly selected 0.2 (i.e., 20%) of the original instances of input โ€˜testโ€™, that were not selected for output โ€˜trainโ€™, and output stream โ€˜testโ€™ is made of the remaining instances of input โ€˜testโ€™.

References: templates.generation.all, tasks.generation

Read more about catalog usage here.