📄 Open Australian Legal Qa¶

cards.rag.response_generation.train.open_australian_legal_qa

type: TaskCard
loader: 
  type: LoadHF
  path: umarbutler/open-australian-legal-qa
preprocess_steps: 
  - type: SplitRandomMix
    mix: 
      train: train[0.5]
      validation: train[0.2]
      test: train[0.3]
  - type: Shuffle
  - type: Copy
    field_to_field: 
      source/text: contexts
      answer: reference_answers
      source/citation: contexts_ids
  - type: ListFieldValues
    fields: 
      - reference_answers
    to_field: reference_answers
  - type: ListFieldValues
    fields: 
      - contexts
    to_field: contexts
  - type: ListFieldValues
    fields: 
      - contexts_ids
    to_field: contexts_ids
task: tasks.rag.response_generation
templates: 
  default: templates.rag.response_generation.please_respond_chat
[source]

Explanation about TaskCard¶

TaskCard delineates the phases in transforming the source dataset into 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 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 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 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 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. 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: 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 Copy¶

Copies values from specified fields to specified fields.

Args (of parent class):
field_to_field (Union[List[List], Dict[str, str]]): A list of lists, where each sublist contains the source field and the destination field, or a dictionary mapping source fields to destination fields.

Examples:
An input instance {“a”: 2, “b”: 3}, when processed by Copy(field_to_field={“a”: “b”} would yield {“a”: 2, “b”: 2}, and when processed by Copy(field_to_field={“a”: “c”} would yield {“a”: 2, “b”: 3, “c”: 2}

with field names containing / , we can also copy inside the field: Copy(field=”a/0”,to_field=”a”) would process instance {“a”: [1, 3]} into {“a”: 1}

Explanation about ListFieldValues¶

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

References: templates.rag.response_generation.please_respond_chat, tasks.rag.response_generation