ray/doc
Zhuohan Li f286356e06 [docs] add pages about examples on training language models with fairseq (#5755)
* add pages about examples on training language models with fairseq and ray autoscaler

* better format

* update ray_train.sh

* Move EFS to the autoscaler file

* nits

* add comments to the code & use a new way to implement checkpoint hook

* small bug fix

* polish the doc

* fix formatting

* yaml

* update docs

* fix the bugs and add preprocess.sh

* fix lint

* Reduce batch size & fix lint

* shorttitle
2019-10-20 20:28:16 -07:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
dev Release 0.7.5 updates (#5727) 2019-09-26 10:30:37 -07:00
examples [docs] add pages about examples on training language models with fairseq (#5755) 2019-10-20 20:28:16 -07:00
kubernetes Improve manual Kubernetes deployment documentation (#5582) 2019-10-03 15:47:49 -07:00
site Clean up top level Ray dir (#5404) 2019-08-08 23:35:55 -07:00
source [docs] add pages about examples on training language models with fairseq (#5755) 2019-10-20 20:28:16 -07:00
tools Clean up top level Ray dir (#5404) 2019-08-08 23:35:55 -07:00
.gitignore [docs] Convert Examples to Gallery (#5414) 2019-09-24 15:46:56 -07:00
make.bat Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
Makefile [docs] Convert Examples to Gallery (#5414) 2019-09-24 15:46:56 -07:00
README.md Only install ray python packages. (#330) 2017-03-01 23:34:44 -08:00
requirements-doc.txt [tune] Readable trial progress output (#5822) 2019-10-08 16:38:39 -07:00

Ray Documentation

To compile the documentation, run the following commands from this directory. Note that Ray must be installed first.

pip install -r requirements-doc.txt
make html
open _build/html/index.html

To test if there are any build errors with the documentation, do the following.

sphinx-build -W -b html -d _build/doctrees source _build/html