ray/doc
Dmitri Gekhtman 8971422d8f
[autoscaler] Use drain node api in autoscaler before terminating nodes (#20013)
* wip

* Draft

* Use bytest for node id

* remove stray helm change

* fix autoscaler init arg

* don't forget to instantiate new load metrics dict

* remove extraneous diff

* Timeout, comments, function signature.

* typo

* another comment

* tweak

* docstring

* shorter timeout

* Use a better error code

* missing self

* Dedent example

* Add drain node prometheus metric.

* comment

* Update tests part 1: test_autoscaler.py

* Update tests part 2: test_resource_demand_scheduler

* lint

* Update tests part 3: test_autoscaling_policy

* Unit tests for new Prometheus metric and DrainNode error handling.

* comment

* removed unused function

* Try adding ability to mock out process termination to fake node provider

* Add integration test.

* fix

* fix

* lint

* Improve log message

* fix

* Simplify test

* Fix doc example

* remove unused dict

* Mock out process termination in a subclass

* Add add doc string and comment explaining prune active ips.

* Comment: wtf is use_node_id_as_ip

* one more comment

* more explanation

* period

* tweak
2021-11-11 08:31:40 -08: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] Add note for multi-node on Windows (#20184) 2021-11-09 16:02:01 -08:00
kubernetes [Core][CoreWorker] increase the default port range (#19541) 2021-11-05 09:25:44 -07:00
site [docs] Move all /latest links to /master (#11897) 2020-11-10 10:53:28 -08:00
source [autoscaler] Use drain node api in autoscaler before terminating nodes (#20013) 2021-11-11 08:31:40 -08:00
tools Shellcheck rewrites (#9597) 2020-07-24 17:24:19 -05:00
yarn [core] Deprecate QuotaAwareEvictionPolicy (#16911) 2021-07-07 13:44:41 -07:00
.gitignore [docs] Convert Examples to Gallery (#5414) 2019-09-24 15:46:56 -07:00
BUILD [train][datasets] add example for big data training (#20042) 2021-11-05 09:28:48 -07:00
make.bat Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
Makefile [Core][Dataset] adding example for large scale data ingestion (#18998) 2021-10-11 15:37:09 -07:00
README.md [docs] Fix broken links in documentation and add linkcheck to documentation (#20030) 2021-11-04 13:19:43 -07:00
requirements-doc.txt [CI] change git protocol to use https. (#19964) 2021-11-01 19:38:58 -07:00
requirements-rtd.txt Bump pillow from 7.2.0 to 8.3.2 in /doc (#18422) 2021-10-23 18:36:14 -07: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

To check if there are broken links, run the following (we are currently not running this in the CI since there are false positives).

make linkcheck