πŸ“„ Token PrecisionΒΆ

metrics.rag.external_rag.context_relevance.token_precision

MetricPipeline(
    main_score="precision",
    preprocess_steps=[
        Copy(
            field="contexts",
            to_field="references",
        ),
        Copy(
            field="question",
            to_field="prediction",
        ),
        MultiTypeSerializer(
            field="prediction",
        ),
    ],
    metric="metrics.token_overlap",
    score_prefix="context_relevance_token_precision_",
)
[source]

from unitxt.operators import Copy
from unitxt.serializers import MultiTypeSerializer

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}

References: metrics.token_overlap

Read more about catalog usage here.