mirror of
https://github.com/vale981/ray
synced 2025-03-06 10:31:39 -05:00

`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`.
29 lines
649 B
ReStructuredText
29 lines
649 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.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)
|