📄 Token Overlap With Context¶

metrics.token_overlap_with_context

MetricPipeline(
    main_score="f1",
    preprocess_steps=[
        Copy(
            field="task_data/context",
            to_field="references",
        ),
        ListFieldValues(
            fields=[
                "references",
            ],
            to_field="references",
        ),
    ],
    metric=TokenOverlap(),
    postprocess_steps=[
        Copy(
            field_to_field=[
                [
                "score/global/f1",
                "score/global/f1_overlap_with_context",
                ],
                [
                "score/global/recall",
                "score/global/recall_overlap_with_context",
                ],
                [
                "score/global/precision",
                "score/global/precision_overlap_with_context",
                ],
            ],
        ),
    ],
)

[source]

from unitxt.metrics import TokenOverlap
from unitxt.operators import Copy, ListFieldValues

Explanation about ListFieldValues¶

Concatenates values of multiple fields into a list, and assigns it to a new field.

Explanation about Copy¶

Copies values from specified fields to specified fields.

Args (of parent class):
field_to_field (Union[List[List], Dict[str, str]]): A list of lists, where each sublist contains the source field and the destination field, or a dictionary mapping source fields to destination fields.

Examples:
An input instance {“a”: 2, “b”: 3}, when processed by Copy(field_to_field={"a": "b"}) would yield {“a”: 2, “b”: 2}, and when processed by Copy(field_to_field={"a": "c"}) would yield {“a”: 2, “b”: 3, “c”: 2}

with field names containing / , we can also copy inside the field: Copy(field="a/0",to_field="a") would process instance {“a”: [1, 3]} into {“a”: 1}