---
dataset_info:
- config_name: default
  features:
  - name: id
    dtype: string
  - name: title
    dtype: string
  - name: doi
    dtype: string
  - name: text
    dtype: string
  - name: tokens
    sequence: string
  - name: start_offsets
    sequence: uint32
  - name: labels
    sequence:
      class_label:
        names:
          '0': O
          '1': B-SOFTWARE
          '2': I-SOFTWARE
          '3': B-VERSION
          '4': I-VERSION
          '5': B-PUBLISHER
          '6': I-PUBLISHER
          '7': B-URL
          '8': I-URL
          '9': B-LANGUAGE
          '10': I-LANGUAGE
  splits:
  - name: train
    num_bytes: 454112647
    num_examples: 128195
  - name: test
    num_bytes: 123119202
    num_examples: 35838
  download_size: 161140090
  dataset_size: 577231849
- config_name: documents
  features:
  - name: id
    dtype: string
  - name: title
    dtype: string
  - name: doi
    dtype: string
  - name: text
    dtype: string
  - name: tokens
    sequence: string
  - name: start_offsets
    sequence: uint32
  - name: labels
    sequence:
      class_label:
        names:
          '0': O
          '1': B-SOFTWARE
          '2': I-SOFTWARE
          '3': B-VERSION
          '4': I-VERSION
          '5': B-PUBLISHER
          '6': I-PUBLISHER
          '7': B-URL
          '8': I-URL
          '9': B-LANGUAGE
          '10': I-LANGUAGE
  - name: software
    sequence:
    - name: name
      dtype: string
    - name: version
      sequence: string
    - name: publisher
      sequence: string
    - name: url
      sequence: string
    - name: language
      sequence: string
  splits:
  - name: train
    num_bytes: 436168690
    num_examples: 3627
  - name: test
    num_bytes: 118092922
    num_examples: 960
  download_size: 186265237
  dataset_size: 554261612
- config_name: paragraphs
  features:
  - name: id
    dtype: string
  - name: title
    dtype: string
  - name: doi
    dtype: string
  - name: text
    dtype: string
  - name: tokens
    sequence: string
  - name: start_offsets
    sequence: uint32
  - name: labels
    sequence:
      class_label:
        names:
          '0': O
          '1': B-SOFTWARE
          '2': I-SOFTWARE
          '3': B-VERSION
          '4': I-VERSION
          '5': B-PUBLISHER
          '6': I-PUBLISHER
          '7': B-URL
          '8': I-URL
          '9': B-LANGUAGE
          '10': I-LANGUAGE
  splits:
  - name: train
    num_bytes: 454112647
    num_examples: 128195
  - name: test
    num_bytes: 123119202
    num_examples: 35838
  download_size: 161140090
  dataset_size: 577231849
configs:
- config_name: default
  data_files:
  - split: train
    path: data/train-*
  - split: test
    path: data/test-*
- config_name: documents
  data_files:
  - split: train
    path: documents/train-*
  - split: test
    path: documents/test-*
- config_name: paragraphs
  data_files:
  - split: train
    path: paragraphs/train-*
  - split: test
    path: paragraphs/test-*
---
# Softcite Dataset

Softcite dataset is a dataset of software mentions in scientific papers. This is the second version of this dataset that is originally available at https://github.com/softcite/softcite_dataset_v2.

In contrast to the dataset at GitHUB repository, this dataset contains the full text of the papers also for the train set. Originally, the full text was only available for the test set.

Empty documents were filtered out.

## Splits naming

- `train`: The training split corresponds to the `softcite_corpus-working` in the original dataset.
- `test`: The test split corresponds to the `softcite_corpus-holdout` in the original dataset.

## Configurations

This dataset is available in two configurations:

- `paragraphs`: This configuration contains the dataset in a format where each paragraph is a separate example. This configuration is the default one.
- `documents`: This configuration contains the dataset in a format where each document is a separate example.

## Fields description

Both configurations contain the following fields:

- `id`: The unique identifier of the example. In case of `paragraphs` configuration, the id format is `{paper_id}_{paragraph_index}`.
- `title`: The title of the paper.
- `doi`: The DOI of the paper if available.
- `text`: The text of the paragraph or the full text of the paper.
- `tokens`: Tokenized text for which the labels are provided.
- `start_offsets`: The start character offsets of the tokens in the text.
- `labels`: The labels of the tokens. The labels are in the BIO format:
    - `0`: O
    - `1`: B-SOFTWARE
    - `2`: I-SOFTWARE
    - `3`: B-VERSION
    - `4`: I-VERSION
    - `5`: B-PUBLISHER
    - `6`: I-PUBLISHER
    - `7`: B-URL
    - `8`: I-URL
    - `9`: B-LANGUAGE
    - `10`: I-LANGUAGE
- `software`: This field is only available in the `documents` configuration. It contains the following fields:
    - `name`: The name of the software.
    - `version`: The versions of the software.
    - `publisher`: The publishers of the software.
    - `url`: The URLs of the software.
    - `language`: The programming languages of the software.
    
Disambiguation is done on lexical level. Meaning that two software names are considered different if they have different normalized forms.
    
## License
This dataset is ment only for internal usage within the SoFAIR project.

The original upload is distributed under CC-BY license. The Python scrips are distributed under Apache 2.0 license.