mirror of
https://github.com/vale981/ray
synced 2025-03-06 10:31:39 -05:00
76bb5396c7
- Adds links to Job Submission from existing library tutorials where `ray submit` is used. When Jobs becomes GA, we should fully replace the uses of `ray submit` with Ray job submission and ensure this is tested. - Adds docstrings for the Jobs SDK, which automatically show up in the API reference - Improve the Job Submission main page - Add a "Deployment Guide" landing page explaining when to use Ray Client vs Ray Jobs Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
69 lines
1.2 KiB
ReStructuredText
69 lines
1.2 KiB
ReStructuredText
.. _ray-job-submission-api-ref:
|
|
|
|
Ray Job Submission API
|
|
======================
|
|
|
|
For an overview with examples see :ref:`Ray Job Submission<jobs-overview>`.
|
|
|
|
.. _ray-job-submission-cli-ref:
|
|
|
|
Job Submission CLI
|
|
------------------
|
|
|
|
.. _ray-job-submit-doc:
|
|
|
|
.. click:: ray.dashboard.modules.job.cli:submit
|
|
:prog: ray job submit
|
|
|
|
.. _ray-job-status-doc:
|
|
|
|
.. click:: ray.dashboard.modules.job.cli:status
|
|
:prog: ray job status
|
|
:show-nested:
|
|
|
|
.. _ray-job-stop-doc:
|
|
|
|
.. click:: ray.dashboard.modules.job.cli:stop
|
|
:prog: ray job stop
|
|
:show-nested:
|
|
|
|
.. _ray-job-logs-doc:
|
|
|
|
.. click:: ray.dashboard.modules.job.cli:logs
|
|
:prog: ray job logs
|
|
:show-nested:
|
|
|
|
.. _ray-job-list-doc:
|
|
|
|
.. click:: ray.dashboard.modules.job.cli:list
|
|
:prog: ray job list
|
|
:show-nested:
|
|
|
|
.. _ray-job-submission-sdk-ref:
|
|
|
|
Job Submission SDK
|
|
------------------
|
|
|
|
.. _job-submission-client-ref:
|
|
|
|
JobSubmissionClient
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: ray.job_submission.JobSubmissionClient
|
|
:members:
|
|
|
|
.. _job-status-ref:
|
|
|
|
JobStatus
|
|
~~~~~~~~~
|
|
|
|
.. autoclass:: ray.job_submission.JobStatus
|
|
:members:
|
|
|
|
.. _job-info-ref:
|
|
|
|
JobInfo
|
|
~~~~~~~
|
|
|
|
.. autoclass:: ray.job_submission.JobInfo
|
|
:members:
|