Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs] Refactor Python API documentation for job submission #32252

Merged
merged 1 commit into from
Feb 7, 2023
Merged

[Docs] Refactor Python API documentation for job submission #32252

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 37 additions & 27 deletions doc/source/cluster/running-applications/job-submission/jobs-package-ref.rst
View file
Open in desktop
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