ray/doc
Richard Liaw aad3c50e2d
[tune] Cluster Fault Tolerance (#3309)
This PR introduces cluster-level fault tolerance for Tune by checkpointing global state. This occurs with relatively high frequency and allows users to easily resume experiments when the cluster crashes.

Note that this PR may affect automated workflows due to auto-prompting, but this is resolvable.
2018-12-29 11:42:25 +08:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
source [tune] Cluster Fault Tolerance (#3309) 2018-12-29 11:42:25 +08:00
make.bat Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
Makefile Move documentation to ReadTheDocs. (#326) 2017-02-27 21:14:31 -08:00
README.md Only install ray python packages. (#330) 2017-03-01 23:34:44 -08:00
requirements-doc.txt [sgd] Add file lock to protect compilation of sgd op (#3486) 2018-12-09 13:52:40 -08: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