gu-zhe/OpenNMT-py

Open Source Neural Machine Translation in PyTorch

OpenNMT-py: Open-Source Neural Machine Translation

OpenNMT-py is the PyTorch version of the OpenNMT project, an open-source (MIT) neural machine translation (and beyond!) framework. It is designed to be research friendly to try out new ideas in translation, language modeling, summarization, and many other NLP tasks. Some companies have proven the code to be production ready.

We love contributions! Please look at issues marked with the contributions welcome tag.

Before raising an issue, make sure you read the requirements and the Full Documentation examples.

Unless there is a bug, please use the Forum or Gitter to ask questions.

---

For beginners:

There is a new step-by-step and explained tuto (Thanks to Yasmin Moslem): Tutorial

Please try to read and/or follow before raising newbies issues.

Otherwise you can just have a look at the Quickstart steps

---

If you used previous versions of OpenNMT-py, you can check the Changelog or the Breaking Changes

---

Tutorials:

• How to finetune NLLB-200 with your dataset: Tuto Finetune NLLB-200
• How to create a simple OpenNMT-py REST Server: Tuto REST
• How to create a simple Web Interface: Tuto Streamlit
• Replicate the WMT17 en-de experiment: WMT17 ENDE

---

Setup

OpenNMT-py requires:

• Python >= 3.8
• PyTorch >= 1.13 <2

Install OpenNMT-py from pip:

pip install OpenNMT-py

or from the sources:

git clone https://github.com/OpenNMT/OpenNMT-py.git
cd OpenNMT-py
pip install -e .

Note: if you encounter a MemoryError during installation, try to use pip with --no-cache-dir.

(Optional) Some advanced features (e.g. working pretrained models or specific transforms) require extra packages, you can install them with:

pip install -r requirements.opt.txt

Features

• End-to-end training with on-the-fly data processing

• Transformer models

• Encoder-decoder models with multiple RNN cells (LSTM, GRU) and attention types (Luong, Bahdanau)

• SRU "RNNs faster than CNN"

• Conv2Conv convolution model

• Copy and Coverage Attention

• Pretrained Embeddings

• Source word features

• TensorBoard logging

• Mixed-precision training with APEX, optimized on Tensor Cores

• Multi-GPU training

• Inference (translation) with batching and beam search

• Model export to CTranslate2, a fast and efficient inference engine

Documentation

Full HTML Documentation

Acknowledgements

OpenNMT-py is run as a collaborative open-source project. Project was incubated by Systran and Harvard NLP in 2016 in Lua and ported to Pytorch in 2017.

Current maintainers:

Ubiqus Team: François Hernandez and Team.

Vincent Nguyen (Seedfall)

Citation

If you are using OpenNMT-py for academic work, please cite the initial system demonstration paper published in ACL 2017:

@inproceedings{klein-etal-2017-opennmt,
    title = "{O}pen{NMT}: Open-Source Toolkit for Neural Machine Translation",
    author = "Klein, Guillaume  and
      Kim, Yoon  and
      Deng, Yuntian  and
      Senellart, Jean  and
      Rush, Alexander",
    booktitle = "Proceedings of {ACL} 2017, System Demonstrations",
    month = jul,
    year = "2017",
    address = "Vancouver, Canada",
    publisher = "Association for Computational Linguistics",
    url = "https://www.aclweb.org/anthology/P17-4012",
    pages = "67--72",
}