hiro/ray
1
0
Fork 0
mirror of https://github.com/vale981/ray synced 2025-03-08 19:41:38 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
ray/doc
History
Richard Liaw 0c3b9ebeef
[tune/sgd] Document func_trainable and add checkpoint context (#9739) 
Co-authored-by: krfricke <krfricke@users.noreply.github.com>
Co-authored-by: Amog Kamsetty <amogkam@users.noreply.github.com>
2020-07-30 09:46:37 -07:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
azure Shellcheck quoting (#9596) 2020-07-21 21:56:41 -05:00
dev Shellcheck rewrites (#9597) 2020-07-24 17:24:19 -05:00
examples Shellcheck rewrites (#9597) 2020-07-24 17:24:19 -05:00
kubernetes Change os.uname()[1] and socket.gethostname() to the portable and faster platform.node_ip() (#8839) 2020-06-08 21:29:46 -07:00
site Replace all instances of ray.readthedocs.io with ray.io (#7994) 2020-04-13 16:17:05 -07:00
source [tune/sgd] Document func_trainable and add checkpoint context (#9739) 2020-07-30 09:46:37 -07:00
tools Shellcheck rewrites (#9597) 2020-07-24 17:24:19 -05:00
yarn Change os.uname()[1] and socket.gethostname() to the portable and faster platform.node_ip() (#8839) 2020-06-08 21:29:46 -07:00
.gitignore [docs] Convert Examples to Gallery (#5414) 2019-09-24 15:46:56 -07:00
BUILD [tune] move jenkins tests to travis (#9609) 2020-07-24 21:22:54 -07:00
make.bat Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
Makefile [tune] New Doc edits, add Concepts page (#8083) 2020-04-25 18:25:56 -07:00
README.md [RLlib] Fix use_lstm flag for ModelV2 (w/o ModelV1 wrapping) and add it for PyTorch. (#8734) 2020-06-05 15:40:30 +02:00
requirements-doc.txt Java doc: "Ray Core Walkthrough" page (#8595) 2020-07-30 11:13:38 +08:00
requirements-rtd.txt [docs] Fix readthedocs rendering (#7810) 2020-03-30 11:40:08 -07:00

README.md

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 -b html -d _build/doctrees source _build/html