hiro/ray
1
0
Fork 0
mirror of https://github.com/vale981/ray synced 2025-03-08 19:41:38 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
ray/doc/source/api.rst

60 lines
1 KiB
ReStructuredText
Raw Normal View History

Move documentation to ReadTheDocs. (#326)
2017-02-27 21:14:31 -08:00
The Ray API
===========
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
.. autofunction:: ray.init
Add ray.is_initialized() function. (#2818) * Add ray.is_initialized() function. * Add assert.
2018-09-06 21:20:59 -07:00
.. autofunction:: ray.is_initialized
Move documentation to ReadTheDocs. (#326)
2017-02-27 21:14:31 -08:00
.. autofunction:: ray.remote
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
.. autofunction:: ray.get
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. autofunction:: ray.wait
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
.. autofunction:: ray.put
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. autofunction:: ray.get_gpu_ids
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. autofunction:: ray.get_resource_ids
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. autofunction:: ray.get_webui_url
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. autofunction:: ray.shutdown
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. autofunction:: ray.register_custom_serializer
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. autofunction:: ray.profile
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. autofunction:: ray.method
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
The Ray Command Line API
------------------------
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. click:: ray.scripts.scripts:start
:prog: ray start
:show-nested:
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. click:: ray.scripts.scripts:stop
:prog: ray stop
:show-nested:
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. click:: ray.scripts.scripts:create_or_update
ray exec and ray attach commands (#2560) ray exec CLUSTER CMD [--screen] [--start] [--stop] ray attach CLUSTER [--start] Example: ray exec sgd.yaml 'source activate tensorflow_p27 && cd ~/ray/python/ray/rllib && ./train.py --run=PPO --env=CartPole-v0' --screen --start --stop This will in one command create a cluster and run the command on it in a screen session. The screen can later be attached to via ray attach. After the command finishes, the cluster workers will be terminated and the head node stopped.
2018-08-15 14:31:50 -07:00
:prog: ray up
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
:show-nested:
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. click:: ray.scripts.scripts:teardown
ray exec and ray attach commands (#2560) ray exec CLUSTER CMD [--screen] [--start] [--stop] ray attach CLUSTER [--start] Example: ray exec sgd.yaml 'source activate tensorflow_p27 && cd ~/ray/python/ray/rllib && ./train.py --run=PPO --env=CartPole-v0' --screen --start --stop This will in one command create a cluster and run the command on it in a screen session. The screen can later be attached to via ray attach. After the command finishes, the cluster workers will be terminated and the head node stopped.
2018-08-15 14:31:50 -07:00
:prog: ray down
:show-nested:
.. click:: ray.scripts.scripts:exec_cmd
:prog: ray exec
:show-nested:
.. click:: ray.scripts.scripts:attach
:prog: ray attach
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
:show-nested:
Expand API documentation. (#375) * Expand API documentation and convert tutorial to rst. * Fix formatting error in tutorial. * Address William's comments. * Address Stephanie's comments.
2017-03-17 16:48:25 -07:00
Change ray.worker.cleanup -> ray.shutdown and improve API documentation. (#2374) * Change ray.worker.cleanup -> ray.shutdown and improve API documentation. * Deprecate ray.worker.cleanup() gracefully. * Fix linting
2018-07-12 14:00:00 -05:00
.. click:: ray.scripts.scripts:get_head_ip
:prog: ray get_head_ip
:show-nested:
Reference in a new issue Copy permalink