sofair_dataset / README.md
mdocekal's picture
Upload dataset
2d9338b verified
metadata
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
      - 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: 54425976
        num_examples: 298
    download_size: 17969333
    dataset_size: 54425976
  - 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: 54425976
        num_examples: 298
    download_size: 17969333
    dataset_size: 54425976
  - 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: 57069714
        num_examples: 17259
    download_size: 16095746
    dataset_size: 57069714
configs:
  - config_name: default
    data_files:
      - split: train
        path: data/train-*
  - config_name: documents
    data_files:
      - split: train
        path: documents/train-*
  - config_name: paragraphs
    data_files:
      - split: train
        path: paragraphs/train-*

SoFAIR Dataset

SoFAIR dataset is a dataset of software mentions in scientific papers that was created as a part of the SoFAIR project (https://sofair.org/).

Skipped annotations

In contrast to the original annotations that are available at https://github.com/SoFairOA/Dataset, we skipped bibliography annotations and software annotations with subtype implicit.

This upload also removes some duplicities that were present in the original dataset. We manually investigated those duplicities and merged them.

Configurations

This dataset is available in two configurations:

  • documents: This configuration contains the dataset in a format where each document is a separate example. This configuration is the default one.
  • paragraphs: This configuration contains the dataset in a format where each paragraph 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. As not every software attribute has mapping to corresponding software, some BIO labeled attributes might not be present here.