📄 Xsum¶

Extreme Summarization (XSum) Dataset. There are three features: - document: Input news article. - summary: One sentence summary of the article. - id: BBC ID of the article… See the full description on the dataset page: https://huggingface.co/datasets/EdinburghNLP/xsum

Tags: annotations_creators:found, arxiv:1808.08745, language:en, language_creators:found, license:unknown, multilinguality:monolingual, region:us, size_categories:100K<n<1M, source_datasets:original, task_categories:summarization, task_ids:news-articles-summarization

cards.xsum

type: TaskCard
loader: 
  type: LoadHF
  path: EdinburghNLP/xsum
task: tasks.summarization.abstractive
preprocess_steps: 
  - type: Wrap
    field: summary
    inside: list
    to_field: summaries
templates: templates.summarization.abstractive.all
[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 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')

References: templates.summarization.abstractive.all, tasks.summarization.abstractive