ray/doc
Richard Liaw 94e2fcea2e
[sgd] fp16 (apex) and scheduler support + move examples page (#7061)
* Init fp16

* fp16 and schedulers

* scheduler linking and fp16

* to fp16

* loss scaling and documentation

* more documentation

* add tests, refactor config

* moredocs

* more docs

* fix logo, add test mode, add fp16 flag

* fix tests

* fix scheduler

* fix apex

* improve safety

* fix tests

* fix tests

* remove pin memory default

* rm

* fix

* Update doc/examples/doc_code/raysgd_torch_signatures.py

* fix

* migrate changes from other PR

* ok thanks

* pass

* signatures

* lint'

* Update python/ray/experimental/sgd/pytorch/utils.py

* Apply suggestions from code review

Co-Authored-By: Edward Oakes <ed.nmi.oakes@gmail.com>

* should address most comments

* comments

* fix this ci

* fix tests'

* testmode

Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
2020-02-16 19:04:08 -08:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
dev Add 0.8.1 release test results (#6943) 2020-01-28 14:14:33 -08:00
examples [sgd] fp16 (apex) and scheduler support + move examples page (#7061) 2020-02-16 19:04:08 -08:00
kubernetes Remove future imports (#6724) 2020-01-09 00:15:48 -08:00
site [bug] Attempt to fix links not working. (#6390) 2019-12-07 14:31:50 -08:00
source [sgd] fp16 (apex) and scheduler support + move examples page (#7061) 2020-02-16 19:04:08 -08:00
tools Clean up top level Ray dir (#5404) 2019-08-08 23:35:55 -07:00
yarn Remove future imports (#6724) 2020-01-09 00:15:48 -08:00
.gitignore [docs] Convert Examples to Gallery (#5414) 2019-09-24 15:46:56 -07:00
make.bat Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
Makefile Improved contributor instructions (#7026) 2020-02-04 14:07:51 -08:00
README.md Only install ray python packages. (#330) 2017-03-01 23:34:44 -08:00
requirements-doc.txt Fix documentation building with psutil issue (#7077) 2020-02-11 10:00:29 -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
make html
open _build/html/index.html

To test if there are any build errors with the documentation, do the following.

sphinx-build -W -b html -d _build/doctrees source _build/html