π Tablebench Fact CheckingΒΆ
This TableBench dataset is a Comprehensive and Complex Benchmark for Table Question Answering. For more details, refer to https://tablebench.github.io/
Tags: modality:table
, urls:{'arxiv': 'https://www.arxiv.org/pdf/2408.09174'}
, languages:['english']
, category:dataset
cards.tablebench_fact_checking
TaskCard
(
loader=LoadHF
(
path="Multilingual-Multimodal-NLP/TableBench",
revision="90593ad8af90f027f6f478b8c4c1981d9f073a83",
data_classification_policy=[
"public",
],
splits=[
"test",
],
),
preprocess_steps=[
SplitRandomMix
(
mix={
"train": "test[20%]",
"validation": "test[20%]",
"test": "test[60%]",
},
),
FilterByCondition
(
values={
"instruction_type": "DP",
},
condition="eq",
),
FilterByCondition
(
values={
"qtype": [
"FactChecking",
],
},
condition="in",
),
Apply
(
function="json.loads",
to_field="table",
_argv=[
"table",
],
),
Rename
(
field_to_field={
"table/columns": "table/header",
"table/data": "table/rows",
},
),
Set
(
fields={
"context_type": "Table",
},
),
Rename
(
field_to_field={
"table": "context",
"answer": "answers",
},
),
RemoveFields
(
fields=[
"instruction",
],
),
],
task=Task
(
input_fields={
"context": "Table",
"context_type": "str",
"question": "str",
"answer_formatter": "str",
},
reference_fields={
"answers": "str",
},
prediction_type="str",
metrics=[
"metrics.rouge",
],
augmentable_inputs=[
"context",
"question",
],
),
templates=[
InputOutputTemplate
(
instruction="You are a table analyst. Your task is to answer questions based on the table content. {answer_formatter}
Output only the final answer without any explanations, extra information, or introductory text.
Here are some input-output examples. Read the examples carefully to figure out the mapping. The output of the last example is not given, and your job is to figure out what it is.",
input_format="{context_type}: {context}
Question: {question}",
target_prefix="Final Answer: ",
output_format="{answers}",
postprocessors=[
"processors.take_first_non_empty_line",
"processors.lower_case",
"processors.remove_punctuations",
"processors.remove_articles",
"processors.fix_whitespace",
],
),
],
)
[source]from unitxt.loaders import LoadHF
from unitxt.operators import Apply, FilterByCondition, RemoveFields, Rename, Set
from unitxt.splitters import SplitRandomMix
from unitxt.task import Task
from unitxt.templates import InputOutputTemplate
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 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"
is4
or8
FilterByCondition(values = {"a":[4,8]}, condition = "not in")
will yield only instances where"a"
is different from4
or8
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 neither4
nor8
FilterByCondition(values = {"a[2]":4}, condition = "le")
will yield only instances where βaβ is a list whose 3-rd element is<= 4
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 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 InputOutputTemplateΒΆ
Generate field βsourceβ from fields designated as input, and fields βtargetβ and βreferencesβ from fields designated as output, of the processed instance.
Args specify the formatting strings with which to glue together the input and reference fields of the processed instance into one string (βsourceβ and βtargetβ), and into a list of strings (βreferencesβ).
Explanation about ApplyΒΆ
A class used to apply a python function and store the result in a field.
- Args:
function (str): name of function. to_field (str): the field to store the result
any additional arguments are field names whose values will be passed directly to the function specified
Examples: Store in field βbβ the uppercase string of the value in field βaβ:
Apply("a", function=str.upper, to_field="b")
Dump the json representation of field βtβ and store back in the same field:
Apply("t", function=json.dumps, to_field="t")
Set the time in a field βbβ:
Apply(function=time.time, to_field="b")
Explanation about RenameΒΆ
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:
Rename(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}]
Rename(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}}]
Rename(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}}]
Rename(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 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β.
Explanation about RemoveFieldsΒΆ
Remove specified fields from each instance in a stream.
- Args:
fields (List[str]): The fields to remove from each instance.
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:
β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: processors.take_first_non_empty_line, processors.remove_punctuations, processors.remove_articles, processors.fix_whitespace, processors.lower_case, metrics.rouge
Read more about catalog usage here.