ray/doc
Kai Fricke 757866ec01
[tune] enable placement groups per default (#13906)
* Refactor placement group factory object to accept placement_group arguments instead of callables

* Convert resources to pgf

* Enable placement groups per default

* Fix tests WIP

* Fix stop/resume with placement groups

* Fix progress reporter test

* Fix trial executor tests

* Check resource for trial, not resource object

* Move ENV vars into class

* Fix tests

* Sphinx

* Wait for trial start in PBT

* Revert merge errors

* Support trial reuse with placement groups

* Better check for just staged trials

* Fix trial queuing

* Wait for pg after trial termination

* Clean up PGs before tune run

* No PG settings in pbt scheduler

* Fix buffering tests

* Skip test if ray reports erroneous available resources

* Disable PG for cluster resource counting test

* Debug output for tests

* Output in-use resources for placement groups

* Don't start new trial on trial start failure

* Add docs

* Cleanup PGs once futures returned

* Fix placement group shutdown

* Use updated_queue flag

* Apply suggestions from code review

* Apply suggestions from code review

* Update docs

* Reuse placement groups independently from actors

* Do not remove placement groups for paused trials

* Only continue enqueueing trials if it didn't fail the first time

* Rename parameter

* Fix pause trial

* Code review + try_recover

* Update python/ray/tune/utils/placement_groups.py

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

* Move placement group lifecycle management

* Move total used resources to pg manager

* Update FAQ example

* Requeue trial if start was unsuccessful

* Do not cleanup pgs at start of run

* Revert "Do not cleanup pgs at start of run"

This reverts commit 933d9c4c

* Delayed PG removal

* Fix trial requeue test

* Trigger pg cleanup on status update

* Fix tests

* Fix docs

* fix-test

Signed-off-by: Richard Liaw <rliaw@berkeley.edu>

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2021-02-23 18:46:02 +01:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
azure [autoscaler] Azure deployment fixes (#11613) 2020-10-27 15:27:18 -07:00
examples [docs] new Ray Cluster documentation (#13839) 2021-02-15 00:47:14 -08:00
kubernetes [autoscaler][kubernetes][docs] Updated Kubernetes Documentation (#14016) 2021-02-11 23:00:25 -08:00
site [docs] Move all /latest links to /master (#11897) 2020-11-10 10:53:28 -08:00
source [tune] enable placement groups per default (#13906) 2021-02-23 18:46:02 +01:00
tools Shellcheck rewrites (#9597) 2020-07-24 17:24:19 -05:00
yarn [docs] redis-port -> port (#10937) 2020-09-23 17:04:13 -07:00
.gitignore [docs] Convert Examples to Gallery (#5414) 2019-09-24 15:46:56 -07:00
BUILD [tune] Try to enable PTL, SKlearn tests (#11542) 2020-10-24 01:08:46 -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 [Docs] update docs readme and fix typo (#10807) 2020-09-15 12:51:18 -07:00
requirements-doc.txt [docs] new Ray Cluster documentation (#13839) 2021-02-15 00:47:14 -08:00
requirements-rtd.txt [redis, docs]: Bump redis and docs/Pillow dependencies (#11371) 2020-11-11 18:15:27 -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
pip install -U -r requirements-rtd.txt # important for reproducing the deployment environment
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