index.rst 1002 B

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. .. fairseq documentation master file, created by
  2. sphinx-quickstart on Fri Aug 17 21:45:30 2018.
  3. You can adapt this file completely to your liking, but it should at least
  4. contain the root `toctree` directive.
  5. :github_url: https://github.com/pytorch/fairseq
  6. fairseq documentation
  7. =====================
  8. Fairseq is a sequence modeling toolkit written in `PyTorch
  9. <http://pytorch.org/>`_ that allows researchers and developers to
  10. train custom models for translation, summarization, language modeling and other
  11. text generation tasks.
  12. .. toctree::
  13. :maxdepth: 1
  14. :caption: Getting Started
  15. getting_started
  16. command_line_tools
  17. .. toctree::
  18. :maxdepth: 1
  19. :caption: Extending Fairseq
  20. overview
  21. tutorial_simple_lstm
  22. tutorial_classifying_names
  23. .. toctree::
  24. :maxdepth: 2
  25. :caption: Library Reference
  26. tasks
  27. models
  28. criterions
  29. optim
  30. lr_scheduler
  31. data
  32. modules
  33. Indices and tables
  34. ==================
  35. * :ref:`genindex`
  36. * :ref:`search`