📄 Law Stack Exchange¶

Dataset from the Law Stack Exchange, as used in “Parameter-Efficient Legal Domain Adaptation”… See the full description on the dataset page: https://huggingface.co/datasets/jonathanli/law-stack-exchange.

Tags: flags:['law', 'stackexchange'], language:en, region:us, task_categories:text-classification

Note

ID: cards.law_stack_exchange | Type: TaskCard

{
    "__description__": "Dataset from the Law Stack Exchange, as used in \"Parameter-Efficient Legal Domain Adaptation\"… See the full description on the dataset page: https://huggingface.co/datasets/jonathanli/law-stack-exchange.",
    "__tags__": {
        "flags": [
            "law",
            "stackexchange"
        ],
        "language": "en",
        "region": "us",
        "task_categories": "text-classification"
    },
    "__type__": "task_card",
    "loader": {
        "__type__": "load_hf",
        "path": "jonathanli/law-stack-exchange"
    },
    "preprocess_steps": [
        {
            "__type__": "split_random_mix",
            "mix": {
                "test": "train",
                "train": "test",
                "validation": "validation"
            }
        },
        {
            "__type__": "rename_fields",
            "field_to_field": {
                "text_label": "label"
            }
        },
        {
            "__type__": "list_field_values",
            "fields": [
                "title",
                "body"
            ],
            "to_field": "text"
        },
        {
            "__type__": "join_str",
            "field": "text",
            "separator": ". ",
            "to_field": "text"
        },
        {
            "__type__": "set",
            "fields": {
                "classes": [
                    "business",
                    "civil-law",
                    "constitutional-law",
                    "contract",
                    "contract-law",
                    "copyright",
                    "criminal-law",
                    "employment",
                    "intellectual-property",
                    "internet",
                    "liability",
                    "licensing",
                    "privacy",
                    "software",
                    "tax-law",
                    "trademark"
                ]
            }
        }
    ],
    "task": "tasks.classification.multi_class.topic_classification",
    "templates": "templates.classification.multi_class.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 JoinStr¶

Joins a list of strings (contents of a field), similar to str.join().

Args:
separator (str): text to put between values

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

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:
RenameFields(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}]

RenameFields(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}}]

RenameFields(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}}]

RenameFields(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}}]

References: tasks.classification.multi_class.topic_classification, templates.classification.multi_class.all