Skip to content

Commit

Permalink
Refactor API documentation for job submission (ray-project#32252)
Browse files Browse the repository at this point in the history
Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
  • Loading branch information
c21 authored and edoakes committed Mar 22, 2023
1 parent be26568 commit f391c23
Showing 1 changed file with 37 additions and 27 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,65 +3,75 @@
Python SDK API Reference
========================

.. currentmodule:: ray.job_submission

For an overview with examples see :ref:`Ray Jobs <jobs-overview>`.

For the CLI reference see :ref:`Ray Job Submission CLI Reference <ray-job-submission-cli-ref>`.

.. _job-submission-client-ref:

JobSubmissionClient
~~~~~~~~~~~~~~~~~~~
.. autosummary::
:nosignatures:
-------------------

ray.job_submission.JobSubmissionClient
ray.job_submission.JobSubmissionClient.submit_job
ray.job_submission.JobSubmissionClient.stop_job
ray.job_submission.JobSubmissionClient.get_job_status
ray.job_submission.JobSubmissionClient.get_job_info
ray.job_submission.JobSubmissionClient.list_jobs
ray.job_submission.JobSubmissionClient.get_job_logs
ray.job_submission.JobSubmissionClient.tail_job_logs
.. autosummary::
:toctree: doc/

.. autoclass:: ray.job_submission.JobSubmissionClient
:members:
JobSubmissionClient
JobSubmissionClient.submit_job
JobSubmissionClient.stop_job
JobSubmissionClient.get_job_status
JobSubmissionClient.get_job_info
JobSubmissionClient.list_jobs
JobSubmissionClient.get_job_logs
JobSubmissionClient.tail_job_logs

.. _job-status-ref:

JobStatus
~~~~~~~~~
---------

.. autoclass:: ray.job_submission.JobStatus
:members:
.. autosummary::
:toctree: doc/

JobStatus

.. _job-info-ref:

JobInfo
~~~~~~~
-------

.. autosummary::
:toctree: doc/

.. autoclass:: ray.job_submission.JobInfo
:members:
JobInfo

.. _job-details-ref:

JobDetails
~~~~~~~~~~
----------

.. autosummary::
:toctree: doc/

.. autopydantic_model:: ray.job_submission.JobDetails
JobDetails

.. _job-type-ref:

JobType
~~~~~~~
-------

.. autoclass:: ray.job_submission.JobType
:members:
:noindex:
.. autosummary::
:toctree: doc/

JobType

.. _driver-info-ref:

DriverInfo
~~~~~~~~~~
----------

.. autopydantic_model:: ray.job_submission.DriverInfo
.. autosummary::
:toctree: doc/

DriverInfo

0 comments on commit f391c23

Please sign in to comment.