📄 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

Note

ID: cards.coedit_error_detection | Type: TaskCard

{
    "__description__": "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"
    },
    "__type__": "task_card",
    "loader": {
        "__type__": "load_hf",
        "filtering_lambda": "lambda x: x['task'] == 'gec'",
        "path": "grammarly/coedit",
        "streaming": true
    },
    "preprocess_steps": [
        "splitters.small_no_test",
        {
            "__type__": "split",
            "by": ": ",
            "field": "src"
        },
        {
            "__type__": "slice",
            "field": "src",
            "start": 1
        },
        {
            "__type__": "join",
            "by": ": ",
            "field": "src"
        },
        {
            "__type__": "list_field_values",
            "fields": [
                "tgt",
                "src"
            ],
            "to_field": "correct_and_incorrect"
        },
        {
            "__type__": "duplicate_by_list",
            "field": "correct_and_incorrect",
            "to_field": "text"
        },
        {
            "__type__": "index_of",
            "index_of": "text",
            "search_in": "correct_and_incorrect",
            "to_field": "label"
        },
        {
            "__type__": "set",
            "fields": {
                "class": "Grammatically incorrect"
            }
        },
        {
            "__type__": "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"
}

Explanation about TaskCard¶

TaskCard delineates the phases in transforming the source dataset into a model-input, and specifies the metrics for evaluation of model-output.

Attributes:
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 a 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 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. streaming: Bool indicating if streaming should be used. filtering_lambda: A lambda function for filtering the data after loading. num_proc: Optional integer to specify 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 ListFieldValues¶

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

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

Adds specified fields to each instance in a given stream or all streams (default) If fields exist, updates 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:
# Add a ‘classes’ field with a value of a list “positive” and “negative” to all streams Set(fields={“classes”: [“positive”,”negatives”]})

# Add a ‘start’ field under the ‘span’ field with a value of 0 to all streams Set(fields={“span/start”: 0}

# Add a ‘classes’ field with a value of a list “positive” and “negative” to ‘train’ stream Set(fields={“classes”: [“positive”,”negatives”], apply_to_stream=[“train”]})

# Add a ‘classes’ field on a given list, prevent 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 IndexOf¶

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

References: splitters.small_no_test, templates.grammatical_error_detection.all