ray/doc
Sven Mika 2d24ef0d32
[RLlib] Add all simple learning tests as framework=tf2. (#19273)
* Unpin gym and deprecate pendulum v0

Many tests in rllib depended on pendulum v0,
however in gym 0.21, pendulum v0 was deprecated
in favor of pendulum v1. This may change reward
thresholds, so will have to potentially rerun
all of the pendulum v1 benchmarks, or use another
environment in favor. The same applies to frozen
lake v0 and frozen lake v1

Lastly, all of the RLlib tests and Tune tests have
been moved to python 3.7

* fix tune test_sampler::testSampleBoundsAx

* fix re-install ray for py3.7 tests

Co-authored-by: avnishn <avnishn@uw.edu>
2021-11-02 12:10:17 +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 [Doc] Update newsreader example (#19893) 2021-10-29 22:25:40 -07:00
kubernetes [k8s][doc] Fix service name in K8s static deployment example (#19065) 2021-10-04 20:23:54 -05:00
site [docs] Move all /latest links to /master (#11897) 2020-11-10 10:53:28 -08:00
source [RLlib] Add all simple learning tests as framework=tf2. (#19273) 2021-11-02 12:10:17 +01: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 [Core][Dataset] adding example for large scale data ingestion (#18998) 2021-10-11 15:37:09 -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] update docs readme and fix typo (#10807) 2020-09-15 12:51:18 -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