mirror of https://github.com/wassname/ray.git synced 2026-07-13 17:45:08 +08:00

Files

T

Max Fitton bde9c734e8 [Documentation] local_mode doc updates and actor / worker explanation from Slack (#10748 )

* wip

* Update local mode docs in all locations

* Update doc/source/actors.rst

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>

* Update doc/source/actors.rst

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>

* Change duplicated text to links to a subtitle for local_mode

* change a reference to be explicit

* Apply suggestions from code review

Co-authored-by: Max Fitton <max@semprehealth.com>
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
Resolved Conflicts:
	doc/source/actors.rst

2020-09-21 17:54:24 +00: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

Bump version number everywhere to 1.0.0

2020-09-09 18:35:14 +00:00

examples

[Documentation] local_mode doc updates and actor / worker explanation from Slack (#10748 )

2020-09-21 17:54:24 +00: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] Simple, universal instead of Simple and universal (#10587 )

2020-09-04 14:04:29 -07:00

source

[Documentation] local_mode doc updates and actor / worker explanation from Slack (#10748 )

2020-09-21 17:54:24 +00: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

[docs] slurm + progress_bar example (#10782 )

2020-09-21 17:52:07 +00: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

[tune] add mode/metric parameters to tune.run (#10627 )

2020-09-08 17:06:21 -07:00

requirements-rtd.txt

[Doc] Use sphinx_book_theme (#10379 )

2020-09-08 16:25:23 -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