|
# Overview |
|
|
|
|
|
This portal provides a detailed documentation of the OpenNMT-py toolkit. It describes how to use the PyTorch project and how it works. |
|
|
|
|
|
|
|
## Installation |
|
Install `OpenNMT-py` from `pip`: |
|
```bash |
|
pip install OpenNMT-py |
|
``` |
|
|
|
or from the sources: |
|
```bash |
|
git clone https://github.com/OpenNMT/OpenNMT-py.git |
|
cd OpenNMT-py |
|
python setup.py install |
|
``` |
|
|
|
*(Optional)* some advanced features (e.g. working pretrained models or specific transforms) requires extra packages, you can install it with: |
|
```bash |
|
pip install -r requirements.opt.txt |
|
``` |
|
|
|
And you are ready to go! |
|
|
|
Take a look at the [quickstart](quickstart) to familiarize yourself with the main training workflow. |
|
|
|
## Citation |
|
|
|
When using OpenNMT-py for research please cite our |
|
[OpenNMT technical report](https://doi.org/10.18653/v1/P17-4012) |
|
|
|
``` |
|
@inproceedings{opennmt, |
|
author = {Guillaume Klein and |
|
Yoon Kim and |
|
Yuntian Deng and |
|
Jean Senellart and |
|
Alexander M. Rush}, |
|
title = {OpenNMT: Open-Source Toolkit for Neural Machine Translation}, |
|
booktitle = {Proc. ACL}, |
|
year = {2017}, |
|
url = {https://doi.org/10.18653/v1/P17-4012}, |
|
doi = {10.18653/v1/P17-4012} |
|
} |
|
``` |
|
|
|
## Additional resources |
|
|
|
You can find additional help or tutorials in the following resources: |
|
|
|
* [Forum](http://forum.opennmt.net/) |
|
|
|
* [Gitter channel](https://gitter.im/OpenNMT/openmt-py) |
|
|