Skip to content
Branch: master
Go to file
Code

Latest commit

brainshawn authored and mariamabarham committed ead583c Jul 3, 2020
Update cfq.py
Make the dataset name consistent with in the paper:  Compositional Freebase Question => Compositional Freebase Questions.

Files

Permalink
Failed to load latest commit information.

README.md



Build GitHub GitHub release Number of datasets

Datasets and evaluation metrics for natural language processing

Compatible with NumPy, Pandas, PyTorch and TensorFlow

πŸŽ“ Colab tutorial: https://colab.research.google.com/github/huggingface/nlp/blob/master/notebooks/Overview.ipynb

πŸ”Ž Online dataset explorer: https://huggingface.co/nlp/viewer

πŸ€— nlp is a lightweight and extensible library to easily share and access datasets and evaluation metrics for Natural Language Processing (NLP).

nlp has many interesting features (beside easy sharing and accessing datasets/metrics):

  • Built-in interoperability with Numpy, Pandas, PyTorch and Tensorflow 2
  • Lightweight and fast with a transparent and pythonic API
  • Strive on large datasets: nlp naturally frees the user from RAM memory limitation, all datasets are memory-mapped on drive by default.
  • Smart caching: never wait for your data to process several times

nlp currently provides access to ~100 NLP datasets and ~10 evaluation metrics and is designed to let the community easily add and share new datasets and evaluation metrics. You can browse the full set of datasets with the live nlp viewer.

nlp originated from a fork of the awesome TensorFlow Datasets and the HuggingFace team want to deeply thank the TensorFlow Datasets team for building this amazing library. More details on the differences between nlp and tfds can be found in the section Main differences between nlp and tfds.

Contributors

Installation

From PyPI

nlp can be installed from PyPi and has to be installed in a virtual environment (venv or conda for instance)

pip install nlp

From source

You can also install nlp from source:

git clone https://github.com/huggingface/nlp
cd nlp
pip install .

When you update the repository, you should upgrade the nlp installation and its dependencies as follows:

git pull
pip install --upgrade .

Using with PyTorch/TensorFlow/pandas

If you plan to use nlp with PyTorch (1.0+), TensorFlow (2.2+) or pandas, you should also install PyTorch, Tensorflow or pandas.

Usage

Using nlp is made to be very simple to use, the main methods are:

  • nlp.list_datasets() to list the available datasets
  • nlp.load_dataset(dataset_name, **kwargs) to instantiate a dataset
  • nlp.list_metrics() to list the available metrics
  • nlp.load_metric(metric_name, **kwargs) to instantiate a metric

Here is a quick example:

import nlp

# Print all the available datasets
print([dataset.id for dataset in nlp.list_datasets()])

# Load a dataset and print the first examples in the training set
squad_dataset = nlp.load_dataset('squad')
print(squad_dataset['train'][0])

# List all the available metrics
print([metric.id for metric in nlp.list_metrics()])

# Load a metric
squad_metric = nlp.load_metric('squad')

Now the best introduction to nlp is to follow the tutorial in Google Colab which is here: Open In Colab

Main differences between nlp and tfds

If you are familiar with the great Tensorflow Datasets, here are the main differences between nlp and tfds:

  • the scripts in nlp are not provided within the library but are queried, downloaded/cached and dynamically loaded upon request
  • nlp also provides evaluation metrics in a similar fashion to the datasets, i.e. as dynamically installed scripts with a unified API. This gives access to the pair of a benchmark dataset and a benchmark metric for instance for benchmarks like SQuAD or GLUE.
  • the backend serialization of nlp is based on Apache Arrow instead of TF Records and leverage python dataclasses for info and features with some diverging features (we mostly don't do encoding and store the raw data as much as possible in the backend serialization cache)
  • the user-facing dataset object of nlp is not a tf.data.Dataset but a built-in framework-agnostic dataset class with methods inspired by what we like in tf.data (like a map() method). It basically wraps a memory-mapped Arrow table cache.

Disclaimers

Similarly to Tensorflow Dataset, nlp is a utility library that downloads and prepares public datasets. We do not host or distribute these datasets, vouch for their quality or fairness, or claim that you have license to use the dataset. It is your responsibility to determine whether you have permission to use the dataset under the dataset's license.

If you're a dataset owner and wish to update any part of it (description, citation, etc.), or do not want your dataset to be included in this library, please get in touch through a GitHub issue. Thanks for your contribution to the ML community!

If you're interested in learning more about responsible AI practices, including fairness, please see Google AI's Responsible AI Practices.

You can’t perform that action at this time.