ray/doc/source/serve/package-ref.md
Sihan Wang 786c7f45cf
[Serve][Doc] Update the doc code to use new api (#27689)
Co-authored-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
2022-08-11 11:24:17 -05:00

931 B

(serve-api)=

Ray Serve API

(core-apis)=

Core APIs

.. autofunction:: ray.serve.run
.. autofunction:: ray.serve.start
.. autofunction:: ray.serve.deployment
.. autofunction:: ray.serve.shutdown

(deployment-api)=

Deployment API

.. autoclass:: ray.serve.deployment.Deployment
    :members: deploy, delete, options, get_handle

(servehandle-api)=

ServeHandle API

.. autoclass:: ray.serve.handle.RayServeHandle
    :members: remote, options

Batching Requests

.. autofunction:: ray.serve.batch(max_batch_size=10, batch_wait_timeout_s=0.0)

Operational APIs

Check out the CLI and REST API for running, debugging, inspecting, and deploying Serve applications in production:

:maxdepth: 1
:name: serve-non-python-api

serve_cli
rest_api