πŸ“„ Human EvalΒΆ

BIGGEN-Bench (BiG Generation Benchmark) is a comprehensive evaluation benchmark designed to assess the capabilities of large language models (LLMs) across a wide range of tasks. This benchmark focuses on free-form text generation and employs fine-grained, instance-specific evaluation criteria. This card is aimed to be used to benchmark LLM judges using the human evaluations as the ground truth.

cards.biggen_bench.results.human_eval

TaskCard(
    loader=LoadHF(
        path="prometheus-eval/BiGGen-Bench-Results",
        splits=[
            "human_eval",
            "multilingual_human_eval",
        ],
    ),
    preprocess_steps=[
        MergeStreams(
            streams_to_merge=[
                "human_eval",
                "multilingual_human_eval",
            ],
            new_stream_name="test",
            add_origin_stream_name=True,
        ),
        FilterByCondition(
            values={
                "human_score": -1,
            },
            condition="ne",
        ),
        ExecuteExpression(
            expression="(human_score - 1) / 4",
            to_field="human_score",
        ),
        Set(
            fields={
                "criteria": {
                    "name": "",
                    "description": "",
                    "options": [
                        {
                        "name": "score1_description",
                        "description": "",
                        },
                        {
                        "name": "score2_description",
                        "description": "",
                        },
                        {
                        "name": "score3_description",
                        "description": "",
                        },
                        {
                        "name": "score4_description",
                        "description": "",
                        },
                        {
                        "name": "score5_description",
                        "description": "",
                        },
                    ],
                    "prediction_field": "response",
                    "context_fields": [
                        "system_prompt",
                        "input",
                        "reference_answer",
                    ],
                    "option_map": {
                        "score1_description": 0.0,
                        "score2_description": 0.25,
                        "score3_description": 0.5,
                        "score4_description": 0.75,
                        "score5_description": 1.0,
                    },
                },
            },
        ),
        FormatText(
            text="{capability}-{task}",
            to_field="criteria_name",
        ),
        Copy(
            field_to_field={
                "criteria_name": "criteria/name",
                "score_rubric/criteria": "criteria/description",
                "score_rubric/score1_description": "criteria/options/0/description",
                "score_rubric/score2_description": "criteria/options/1/description",
                "score_rubric/score3_description": "criteria/options/2/description",
                "score_rubric/score4_description": "criteria/options/3/description",
                "score_rubric/score5_description": "criteria/options/4/description",
            },
        ),
        CreateCriteriaWithOptionsFromDict(
            field="criteria",
        ),
    ],
    task=Task(
        input_fields={
            "system_prompt": "str",
            "input": "str",
            "response": "str",
            "reference_answer": "str",
            "language": "str",
            "capability": "str",
            "task": "str",
            "criteria": "Any",
        },
        reference_fields={
            "human_score": "float",
        },
        prediction_type="float",
        metrics=[
            "metrics.spearman",
            "metrics.pearson",
        ],
        default_template="templates.empty[postprocessors=[processors.cast_to_float_return_nan_if_failed]]",
    ),
    templates=[],
)
[source]

from unitxt.llm_as_judge_operators import CreateCriteriaWithOptionsFromDict
from unitxt.loaders import LoadHF
from unitxt.operators import Copy, ExecuteExpression, FilterByCondition, MergeStreams, Set
from unitxt.string_operators import FormatText
from unitxt.task import Task

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 SetΒΆ

Sets specified fields in each instance, in a given stream or all streams (default), with specified values. If fields exist, updates them, if do not exist – adds 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:

# Set a value of a list consisting of β€œpositive” and β€œnegative” do field β€œclasses” to each and every instance of all streams Set(fields={"classes": ["positive","negatives"]})

# In each and every instance of all streams, field β€œspan” is to become a dictionary containing a field β€œstart”, in which the value 0 is to be set Set(fields={"span/start": 0}

# In all instances of stream β€œtrain” only, Set field β€œclasses” to have the value of a list consisting of β€œpositive” and β€œnegative” Set(fields={"classes": ["positive","negatives"], apply_to_stream=["train"]})

# Set field β€œclasses” to have the value of a given list, preventing modification of original list from changing the instance. Set(fields={"classes": alist}), use_deepcopy=True) if now alist is modified, still the instances remain intact.

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:
  1. β€œinput_fields” whose value is a sub-dictionary of the input instance, consisting of all the fields listed in Arg β€˜input_fields’.

  2. β€œreference_fields” – for the fields listed in Arg β€œreference_fields”.

  3. β€œmetrics” – to contain the value of Arg β€˜metrics’

Explanation about FilterByConditionΒΆ

Filters a stream, yielding only instances in which the values in required fields follow the required condition operator.

Raises an error if a required field name is missing from the input instance.

Args:

values (Dict[str, Any]): Field names and respective Values that instances must match according the condition, to be included in the output.

condition: the name of the desired condition operator between the specified (sub) field’s value and the provided constant value. Supported conditions are (β€œgt”, β€œge”, β€œlt”, β€œle”, β€œne”, β€œeq”, β€œin”,”not in”)

error_on_filtered_all (bool, optional): If True, raises an error if all instances are filtered out. Defaults to True.

Examples:
FilterByCondition(values = {"a":4}, condition = "gt") will yield only instances where field "a" contains a value > 4
FilterByCondition(values = {"a":4}, condition = "le") will yield only instances where "a"<=4
FilterByCondition(values = {"a":[4,8]}, condition = "in") will yield only instances where "a" is 4 or 8
FilterByCondition(values = {"a":[4,8]}, condition = "not in") will yield only instances where "a" is different from 4 or 8
FilterByCondition(values = {"a/b":[4,8]}, condition = "not in") will yield only instances where "a" is a dict in which key "b" is mapped to a value that is neither 4 nor 8
FilterByCondition(values = {"a[2]":4}, condition = "le") will yield only instances where β€œa” is a list whose 3-rd element is <= 4
FilterByCondition(values = {"a":False}, condition = "exists") will yield only instances which do not contain a field named "a"
FilterByCondition(values = {"a/b":True}, condition = "exists") will yield only instances which contain a field named "a" whose value is a dict containing, in turn, a field named "b"

Explanation about ExecuteExpressionΒΆ

Compute an expression, specified as a string to be eval-uated, over the instance’s fields, and store the result in field to_field.

Raises an error if a field mentioned in the query is missing from the instance.

Args:

expression (str): an expression to be evaluated over the fields of the instance to_field (str): the field where the result is to be stored into imports_list (List[str]): names of imports needed for the eval of the query (e.g. β€˜re’, β€˜json’)

Examples:

When instance {β€œa”: 2, β€œb”: 3} is process-ed by operator ExecuteExpression(expression=”a+b”, to_field = β€œc”) the result is {β€œa”: 2, β€œb”: 3, β€œc”: 5}

When instance {β€œa”: β€œhello”, β€œb”: β€œworld”} is process-ed by operator ExecuteExpression(expression = β€œa+’ β€˜+b”, to_field = β€œc”) the result is {β€œa”: β€œhello”, β€œb”: β€œworld”, β€œc”: β€œhello world”}

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 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}

Explanation about MergeStreamsΒΆ

Merges multiple streams into a single stream.

Args:

new_stream_name (str): The name of the new stream resulting from the merge. add_origin_stream_name (bool): Whether to add the origin stream name to each instance. origin_stream_name_field_name (str): The field name for the origin stream name.

References: processors.cast_to_float_return_nan_if_failed, metrics.spearman, metrics.pearson, templates.empty

Read more about catalog usage here.