ray/doc/source/serve/package-ref.md

1,006 B

(serve-api)=

Ray Serve API

(core-apis)=

Core APIs

.. autofunction:: ray.serve.start
.. autofunction:: ray.serve.deployment
.. autofunction:: ray.serve.list_deployments
.. autofunction:: ray.serve.get_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