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

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.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)
[docs] landing page (fixes #21750) (#21859) Co-authored-by: Richard Liaw <rliaw@berkeley.edu> 2022-01-27 02:14:25 +01:00			`Ray Serve API`
			`=============`
[Serve] Add package reference and links keyword to docstring (#8955) 2020-06-15 18:47:59 -07:00
[serve] Deprecate client-based API in favor of process-wide singleton (#14696) 2021-03-17 09:39:54 -05:00			`Core APIs`
			`---------`
[serve] Serve client refactor (#10409) 2020-09-04 12:02:23 -05:00			`.. autofunction:: ray.serve.start`
[serve] Update docs for v2 Deployments API (#15582) 2021-05-03 13:19:34 -05:00			`.. autofunction:: ray.serve.deployment`
			`.. autofunction:: ray.serve.list_deployments`
			`.. autofunction:: ray.serve.get_deployment`
			`.. autofunction:: ray.serve.shutdown`
[Serve] Add package reference and links keyword to docstring (#8955) 2020-06-15 18:47:59 -07:00
[serve] Update docs for v2 Deployments API (#15582) 2021-05-03 13:19:34 -05:00			.. _`deployment-api`:

			`Deployment API`
			`--------------`

[serve] Create `deployment.py` and `deployment_graph.py` (#23578) `api.py` has accumulated classes and functions that aren't purely public APIs, causing circular dependencies. This change pulls `Deployment` and deployment graph-related features out of `api.py` and puts them in two new files: `deployment.py` and `deployment_graph.py`. 2022-04-01 13:40:13 -07:00			`.. autoclass:: ray.serve.deployment.Deployment`
[serve] Update docs for v2 Deployments API (#15582) 2021-05-03 13:19:34 -05:00			`:members: deploy, delete, options, get_handle`
[Serve] Add package reference and links keyword to docstring (#8955) 2020-06-15 18:47:59 -07:00
[Serve] [Doc] Front page update (#13032) 2020-12-28 10:19:36 -08:00			.. _`servehandle-api`:

			`ServeHandle API`
			`---------------`
[Serve] Add package reference and links keyword to docstring (#8955) 2020-06-15 18:47:59 -07:00			`.. autoclass:: ray.serve.handle.RayServeHandle`
[serve] Serve client refactor (#10409) 2020-09-04 12:02:23 -05:00			`:members: remote, options`
[Serve] Add package reference and links keyword to docstring (#8955) 2020-06-15 18:47:59 -07:00
[serve] Serve client refactor (#10409) 2020-09-04 12:02:23 -05:00			`Batching Requests`
			`-----------------`
[serve] Clean up package ref (#15690) 2021-05-11 03:23:58 -05:00			`.. autofunction:: ray.serve.batch(max_batch_size=10, batch_wait_timeout_s=0.0)`