| .. fairseq documentation master file, created by |
| sphinx-quickstart on Fri Aug 17 21:45:30 2018. |
| You can adapt this file completely to your liking, but it should at least |
| contain the root `toctree` directive. |
|
|
| :github_url: https://github.com/pytorch/fairseq |
|
|
|
|
| fairseq documentation |
| ===================== |
|
|
| Fairseq is a sequence modeling toolkit written in `PyTorch |
| <http://pytorch.org/>`_ that allows researchers and developers to |
| train custom models for translation, summarization, language modeling and other |
| text generation tasks. |
|
|
| .. toctree:: |
| :maxdepth: 1 |
| :caption: Getting Started |
|
|
| getting_started |
| command_line_tools |
|
|
| .. toctree:: |
| :maxdepth: 1 |
| :caption: Extending Fairseq |
|
|
| overview |
| tutorial_simple_lstm |
| tutorial_classifying_names |
|
|
| .. toctree:: |
| :maxdepth: 2 |
| :caption: Library Reference |
|
|
| tasks |
| models |
| criterions |
| optim |
| lr_scheduler |
| data |
| modules |
|
|
|
|
| Indices and tables |
| ================== |
|
|
| * :ref:`genindex` |
| * :ref:`search` |
|
|