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, bind

(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)

Serve CLI and REST API

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

Deployment Graph APIs

.. autofunction:: ray.serve.api.build

% TODO(architkulkarni): This just compiles to "alias of Deployment(name=DAGDriver,version=None,route_prefix=/)" % in the docs, find out how to make Sphinx correctly autodocument this class. % {eval-rst} % .. autoclass:: ray.serve.drivers.DAGDriver % :members: predict, predict_with_route %

1.3 KiB Raw Blame History