ray/doc/source/serve/package-ref.rst
Max Pumperla b34099e764
[docs] landing page (fixes #21750) (#21859)
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2022-01-26 17:14:25 -08:00

36 lines
778 B
ReStructuredText

Ray Serve API
=============
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.api.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)
Serve Pipeline API
------------------
.. autoclass:: ray.serve.pipeline.PipelineStep
.. autoclass:: ray.serve.pipeline.ExecutionMode