ray/doc
Ujval Misra ca651af1d7 [tune] Async restores and S3/GCP-capable trial FT (#6376)
* Initial commit for asynchronous save/restore

* Set stage for cloud checkpointable trainable.

* Refactor log_sync and sync_client.

* Add durable trainable impl.

* Support delete in cmd based client

* Fix some tests and such

* Cleanup, comments.

* Use upload_dir instead.

* Revert files belonging to other PR in split.

* Pass upload_dir into trainable init.

* Pickle checkpoint at driver, more robust checkpoint_dir discovery.

* Cleanup trainable helper functions, fix tests.

* Addressed comments.

* Fix bugs from cluster testing, add parameterized cluster tests.

* Add trainable util test

* package_ref

* pbt_address

* Fix bug after running pbt example (_save returning dir).

* get cluster tests running, other bug fixes.

* raise_errors

* Fix deleter bug, add durable trainable example.

* Fix cluster test bugs.

* filelock

* save/restore bug fixes

* .

* Working cluster tests.

* Lint, revert to tracking memory checkpoints.

* Documentation, cleanup

* fixinitialsync

* fix_one_test

* Fix cluster test bug

* nit

* lint

* Revert tune md change

* Fix basename bug for directories.

* lint

* fix_tests

* nit_fix

* Add __init__ file.

* Move to utils package

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-01-02 20:40:53 -08:00
..
_build Get Sphinx infrastructure in place 2016-07-01 18:21:02 -07:00
dev Release 0.8.0 test logs (#6512) 2019-12-17 15:56:50 -08:00
examples Remove public facing references to --redis-address. (#6631) 2019-12-31 13:21:53 -08:00
kubernetes Remove public facing references to --redis-address. (#6631) 2019-12-31 13:21:53 -08:00
site [bug] Attempt to fix links not working. (#6390) 2019-12-07 14:31:50 -08:00
source [tune] Async restores and S3/GCP-capable trial FT (#6376) 2020-01-02 20:40:53 -08:00
tools Clean up top level Ray dir (#5404) 2019-08-08 23:35:55 -07:00
yarn [docs] yarn update (#6173) 2019-11-19 16:15:08 -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 [docs] Convert Examples to Gallery (#5414) 2019-09-24 15:46:56 -07:00
README.md Only install ray python packages. (#330) 2017-03-01 23:34:44 -08:00
requirements-doc.txt [Serve] Added deadline awareness (#6442) 2019-12-11 16:41:54 -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