2020-09-04 12:02:23 -05:00
|
|
|
Serve API Reference
|
|
|
|
|
===================
|
2020-06-15 18:47:59 -07:00
|
|
|
|
2021-03-17 09:39:54 -05:00
|
|
|
Core APIs
|
|
|
|
|
---------
|
2020-09-04 12:02:23 -05:00
|
|
|
.. autofunction:: ray.serve.start
|
|
|
|
|
.. autofunction:: ray.serve.connect
|
2021-03-17 09:39:54 -05:00
|
|
|
.. autofunction:: ray.serve.create_backend
|
|
|
|
|
.. autofunction:: ray.serve.list_backends
|
|
|
|
|
.. autofunction:: ray.serve.delete_backend
|
|
|
|
|
.. autofunction:: ray.serve.get_backend_config
|
|
|
|
|
.. autofunction:: ray.serve.update_backend_config
|
|
|
|
|
.. autofunction:: ray.serve.create_endpoint
|
|
|
|
|
.. autofunction:: ray.serve.list_endpoints
|
|
|
|
|
.. autofunction:: ray.serve.delete_endpoint
|
|
|
|
|
.. autofunction:: ray.serve.set_traffic
|
|
|
|
|
.. autofunction:: ray.serve.shadow_traffic
|
|
|
|
|
.. autofunction:: ray.serve.get_handle
|
|
|
|
|
.. autofunction:: ray.serve.shutdown
|
2020-06-15 18:47:59 -07:00
|
|
|
|
2020-09-04 12:02:23 -05:00
|
|
|
Backend Configuration
|
|
|
|
|
---------------------
|
|
|
|
|
.. autoclass:: ray.serve.BackendConfig
|
2020-06-15 18:47:59 -07:00
|
|
|
|
2020-12-28 10:19:36 -08:00
|
|
|
.. _`servehandle-api`:
|
|
|
|
|
|
|
|
|
|
ServeHandle API
|
|
|
|
|
---------------
|
2020-06-15 18:47:59 -07:00
|
|
|
.. autoclass:: ray.serve.handle.RayServeHandle
|
2020-09-04 12:02:23 -05:00
|
|
|
:members: remote, options
|
2020-06-15 18:47:59 -07:00
|
|
|
|
2020-09-04 15:50:56 -07:00
|
|
|
When calling from Python, the backend implementation will receive ``ServeRequest``
|
2020-12-21 13:34:15 -08:00
|
|
|
objects instead of Starlette requests.
|
2020-09-04 15:50:56 -07:00
|
|
|
|
|
|
|
|
.. autoclass:: ray.serve.utils.ServeRequest
|
|
|
|
|
:members:
|
|
|
|
|
|
2020-09-04 12:02:23 -05:00
|
|
|
Batching Requests
|
|
|
|
|
-----------------
|
2020-06-15 18:47:59 -07:00
|
|
|
.. autofunction:: ray.serve.accept_batch
|
