Skip to main content

Facebook AI Research Sequence-to-Sequence Toolkit

Project description



MIT License Latest Release Build Status Documentation Status


Fairseq(-py) is a sequence modeling toolkit that allows researchers and developers to train custom models for translation, summarization, language modeling and other text generation tasks. We provide reference implementations of various sequence modeling papers:

List of implemented papers

What's New:

Previous updates

Features:

  • multi-GPU training on one machine or across multiple machines (data and model parallel)
  • fast generation on both CPU and GPU with multiple search algorithms implemented:
  • large mini-batch training even on a single GPU via delayed updates
  • mixed precision training (trains faster with less GPU memory on NVIDIA tensor cores)
  • extensible: easily register new models, criterions, tasks, optimizers and learning rate schedulers

We also provide pre-trained models for translation and language modeling with a convenient torch.hub interface:

en2de = torch.hub.load('pytorch/fairseq', 'transformer.wmt19.en-de.single_model')
en2de.translate('Hello world', beam=5)
# 'Hallo Welt'

See the PyTorch Hub tutorials for translation and RoBERTa for more examples.

Requirements and Installation

  • PyTorch version >= 1.5.0
  • Python version >= 3.6
  • For training new models, you'll also need an NVIDIA GPU and NCCL
  • To install fairseq and develop locally:
git clone https://github.com/pytorch/fairseq
cd fairseq
pip install --editable ./

# on MacOS:
# CFLAGS="-stdlib=libc++" pip install --editable ./
  • For faster training install NVIDIA's apex library:
git clone https://github.com/NVIDIA/apex
cd apex
pip install -v --no-cache-dir --global-option="--cpp_ext" --global-option="--cuda_ext" \
  --global-option="--deprecated_fused_adam" --global-option="--xentropy" \
  --global-option="--fast_multihead_attn" ./
  • For large datasets install PyArrow: pip install pyarrow
  • If you use Docker make sure to increase the shared memory size either with --ipc=host or --shm-size as command line options to nvidia-docker run.

Getting Started

The full documentation contains instructions for getting started, training new models and extending fairseq with new model types and tasks.

Pre-trained models and examples

We provide pre-trained models and pre-processed, binarized test sets for several tasks listed below, as well as example training and evaluation commands.

We also have more detailed READMEs to reproduce results from specific papers:

Join the fairseq community

License

fairseq(-py) is MIT-licensed. The license applies to the pre-trained models as well.

Citation

Please cite as:

@inproceedings{ott2019fairseq,
  title = {fairseq: A Fast, Extensible Toolkit for Sequence Modeling},
  author = {Myle Ott and Sergey Edunov and Alexei Baevski and Angela Fan and Sam Gross and Nathan Ng and David Grangier and Michael Auli},
  booktitle = {Proceedings of NAACL-HLT 2019: Demonstrations},
  year = {2019},
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fairseq-0.10.1.tar.gz (925.0 kB view details)

Uploaded Source

Built Distributions

fairseq-0.10.1-cp38-cp38-manylinux1_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.8

fairseq-0.10.1-cp38-cp38-macosx_10_9_x86_64.whl (1.1 MB view details)

Uploaded CPython 3.8 macOS 10.9+ x86-64

fairseq-0.10.1-cp37-cp37m-manylinux1_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.7m

fairseq-0.10.1-cp37-cp37m-macosx_10_9_x86_64.whl (1.1 MB view details)

Uploaded CPython 3.7m macOS 10.9+ x86-64

fairseq-0.10.1-cp36-cp36m-manylinux1_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.6m

fairseq-0.10.1-cp36-cp36m-macosx_10_9_x86_64.whl (1.1 MB view details)

Uploaded CPython 3.6m macOS 10.9+ x86-64

File details

Details for the file fairseq-0.10.1.tar.gz.

File metadata

  • Download URL: fairseq-0.10.1.tar.gz
  • Upload date:
  • Size: 925.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.10

File hashes

Hashes for fairseq-0.10.1.tar.gz
Algorithm Hash digest
SHA256 05b9e6bea4fc974b33e0ee5c154ec4069c6996be30c53d3ea8dd6d13113170f2
MD5 0a26502a647bd7c6800f4f9a64c19454
BLAKE2b-256 52008668312a50a607d1ceb4a6f0804662a04f7b029857679f518a2ec4777d75

See more details on using hashes here.

Provenance

File details

Details for the file fairseq-0.10.1-cp38-cp38-manylinux1_x86_64.whl.

File metadata

  • Download URL: fairseq-0.10.1-cp38-cp38-manylinux1_x86_64.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.10

File hashes

Hashes for fairseq-0.10.1-cp38-cp38-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 f4eff34e1fceca214a8d94b42282a6b33bd82dc376d4f2da9334ffe4c8bd92f5
MD5 e1256bbefca973fd16ef3bbd5ace1e0c
BLAKE2b-256 623ca5aa58af1c48b539ee1eddbcf999647b2c74c7257cc4296c7aed6592e668

See more details on using hashes here.

Provenance

File details

Details for the file fairseq-0.10.1-cp38-cp38-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: fairseq-0.10.1-cp38-cp38-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: CPython 3.8, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.10

File hashes

Hashes for fairseq-0.10.1-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 4a9bbb1a147f09ffe5c5739ea209fdf5693330297b5fd3e9f54343af971510b6
MD5 a28bce5815b2faff49fda81bafb7a1f9
BLAKE2b-256 e06c3339047d0746273ab98e1d9e4b1f5dbf2d2291c2db982bac49a3b78e4010

See more details on using hashes here.

Provenance

File details

Details for the file fairseq-0.10.1-cp37-cp37m-manylinux1_x86_64.whl.

File metadata

  • Download URL: fairseq-0.10.1-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.10

File hashes

Hashes for fairseq-0.10.1-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 56bee96723bdcac431485f2f866c0a875eb8fa7bf08827330360c146dbc0d86b
MD5 4a898af6076f728734890edf56c422c5
BLAKE2b-256 d7a28883a7b699a2315465836ffdbd3ad1ef347645196093783e063539ae8462

See more details on using hashes here.

Provenance

File details

Details for the file fairseq-0.10.1-cp37-cp37m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: fairseq-0.10.1-cp37-cp37m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: CPython 3.7m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.10

File hashes

Hashes for fairseq-0.10.1-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 70d70f9cee2f072a3333908e690049667b1510dd956385c1a012bfe6cf10505b
MD5 ac1cbd388b06572b16d5c8f1221ae1da
BLAKE2b-256 7cd09d423ca79791bbf401a10dd3d44105c0ef8bbcf469f500a5be75ef88d79e

See more details on using hashes here.

Provenance

File details

Details for the file fairseq-0.10.1-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

  • Download URL: fairseq-0.10.1-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.10

File hashes

Hashes for fairseq-0.10.1-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 319a79807b112bde3ecb81fbf7836f9a7f57588c38f16dc7b4281ff5cbdb448e
MD5 4fc4cfbab98c15bdc8bbabb5a79e86c2
BLAKE2b-256 2cda7c7032988dade3b21ccfd5b226e50b382abfd3459129d67240bb004506ae

See more details on using hashes here.

Provenance

File details

Details for the file fairseq-0.10.1-cp36-cp36m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: fairseq-0.10.1-cp36-cp36m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: CPython 3.6m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.10

File hashes

Hashes for fairseq-0.10.1-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 12cebaf282a115baaf6f164b4effcdb30da595ce8845a8294c356c6897974d55
MD5 bde2713f28c15e7c12e7eec0110e0cb3
BLAKE2b-256 758e3b1f2088e67a1f686f05024357a2558c840f7c3927bbef7f323e22350b75

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page