📄 Relation¶

Note

ID: tasks.classification.multi_class.relation | Type: Task

{
    "__type__": "task",
    "augmentable_inputs": [
        "text_a",
        "text_b"
    ],
    "defaults": {
        "text_a_type": "first text",
        "text_b_type": "second text"
    },
    "input_fields": {
        "classes": "List[str]",
        "text_a": "str",
        "text_a_type": "str",
        "text_b": "str",
        "text_b_type": "str",
        "type_of_relation": "str"
    },
    "metrics": [
        "metrics.f1_micro",
        "metrics.accuracy",
        "metrics.f1_macro"
    ],
    "prediction_type": "str",
    "reference_fields": {
        "label": "str"
    }
}

Explanation about Task¶

Task packs the different instance fields into dictionaries by their roles in the task.

Attributes:

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.accuracy, metrics.f1_macro, metrics.f1_micro