📄 Coedit Error Detection¶

This is the dataset that was used to train the CoEdIT text editing models. Full details of the dataset can be found in our paper… See the full description on the dataset page: https://huggingface.co/datasets/grammarly/coedit.

Tags: arxiv:2305.09857, language:en, license:apache-2.0, region:us, size_categories:10K<n<100K, task_categories:text-generation, category:dataset

cards.coedit_error_detection

TaskCard(
    loader=LoadHF(
        path="grammarly/coedit",
        streaming=True,
        filtering_lambda="lambda x: x['task'] == 'gec'",
    ),
    preprocess_steps=[
        "splitters.small_no_test",
        Split(
            field="src",
            by=": ",
        ),
        Slice(
            field="src",
            start=1,
        ),
        Join(
            field="src",
            by=": ",
        ),
        ListFieldValues(
            fields=[
                "tgt",
                "src",
            ],
            to_field="correct_and_incorrect",
        ),
        DuplicateByList(
            field="correct_and_incorrect",
            to_field="text",
        ),
        IndexOf(
            index_of="text",
            search_in="correct_and_incorrect",
            to_field="label",
        ),
        Set(
            fields={
                "class": "Grammatically incorrect",
            },
        ),
        Shuffle(
            page_size=9223372036854775807,
        ),
    ],
    task="tasks.classification.binary.zero_or_one[metrics=[metrics.accuracy,metrics.f1_binary,metrics.precision_binary,metrics.recall_binary]]",
    templates="templates.grammatical_error_detection.all",
)

[source]

from unitxt.collections_operators import DuplicateByList, Slice
from unitxt.loaders import LoadHF
from unitxt.operators import IndexOf, ListFieldValues, Set, Shuffle
from unitxt.string_operators import Join, Split

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 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 Shuffle¶

Shuffles the order of instances in each page of a stream.

Args (of superclass):
page_size (int): The size of each page in the stream. Defaults to 1000.

Explanation about ListFieldValues¶

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

Explanation about IndexOf¶

For a given instance, finds the offset of value of field ‘index_of’, within the value of field ‘search_in’.

References: templates.grammatical_error_detection.all, tasks.classification.binary.zero_or_one, metrics.precision_binary, splitters.small_no_test, metrics.recall_binary, metrics.f1_binary, metrics.accuracy