hiro/ray
1
0
Fork 0
mirror of https://github.com/vale981/ray synced 2025-03-07 02:51:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
ray/doc
History
Clark Zinzow 0c0b0d0a73
[Core] Added support for submission-time task names. (#10449) 
* Added support for submission-time task names.

* Suggestions from code review: add missing consts

Co-authored-by: SangBin Cho <rkooo567@gmail.com>

* Add num_returns arg to actor method options docstring example.

* Add process name line and proctitle assertion to submission-time task name section of advanced docs.

* Add submission-time task name --> proctitle test for Python worker.

* Added Python actor options tests for num_returns and name.

* Added Java test for submission-time task names.

* Add dashboard image to task name docs section.

* Move to fstrings.

Co-authored-by: SangBin Cho <rkooo567@gmail.com>
2020-09-03 11:45:24 -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 Add shellcheck support (#8574) 2020-07-30 18:39:28 -05:00
examples ci: Redo format.sh --all script & backfill lint fixes (#9956) 2020-08-07 16:49:49 -07: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 [1.0] Ray whitepaper link and tagline update (#10455) 2020-09-01 09:48:35 -07:00
source [Core] Added support for submission-time task names. (#10449) 2020-09-03 11:45:24 -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] fix testing for serve-tune test breaking (#9993) 2020-08-07 23:05:18 -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 [Hotfix] Pin opencv-python-headless==4.3.0.36 (#10049) 2020-08-11 15:58:18 -07: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