2022-05-10 14:04:17 -07:00
|
|
|
# Ray Serve API
|
2020-06-15 18:47:59 -07:00
|
|
|
|
2022-05-10 14:04:17 -07:00
|
|
|
## Core APIs
|
|
|
|
|
|
|
|
```{eval-rst}
|
2020-09-04 12:02:23 -05:00
|
|
|
.. autofunction:: ray.serve.start
|
2022-05-10 14:04:17 -07:00
|
|
|
```
|
|
|
|
|
|
|
|
```{eval-rst}
|
2021-05-03 13:19:34 -05:00
|
|
|
.. autofunction:: ray.serve.deployment
|
2022-05-10 14:04:17 -07:00
|
|
|
```
|
|
|
|
|
|
|
|
```{eval-rst}
|
2021-05-03 13:19:34 -05:00
|
|
|
.. autofunction:: ray.serve.list_deployments
|
2022-05-10 14:04:17 -07:00
|
|
|
```
|
|
|
|
|
|
|
|
```{eval-rst}
|
2021-05-03 13:19:34 -05:00
|
|
|
.. autofunction:: ray.serve.get_deployment
|
2022-05-10 14:04:17 -07:00
|
|
|
```
|
|
|
|
|
|
|
|
```{eval-rst}
|
2021-05-03 13:19:34 -05:00
|
|
|
.. autofunction:: ray.serve.shutdown
|
2022-05-10 14:04:17 -07:00
|
|
|
```
|
2020-06-15 18:47:59 -07:00
|
|
|
|
2022-05-10 14:04:17 -07:00
|
|
|
(deployment-api)=
|
2021-05-03 13:19:34 -05:00
|
|
|
|
2022-05-10 14:04:17 -07:00
|
|
|
## Deployment API
|
2021-05-03 13:19:34 -05:00
|
|
|
|
2022-05-10 14:04:17 -07:00
|
|
|
```{eval-rst}
|
2022-04-01 13:40:13 -07:00
|
|
|
.. autoclass:: ray.serve.deployment.Deployment
|
2021-05-03 13:19:34 -05:00
|
|
|
:members: deploy, delete, options, get_handle
|
2022-05-10 14:04:17 -07:00
|
|
|
```
|
|
|
|
|
|
|
|
(servehandle-api)=
|
2020-06-15 18:47:59 -07:00
|
|
|
|
2022-05-10 14:04:17 -07:00
|
|
|
## ServeHandle API
|
2020-12-28 10:19:36 -08:00
|
|
|
|
2022-05-10 14:04:17 -07:00
|
|
|
```{eval-rst}
|
2020-06-15 18:47:59 -07:00
|
|
|
.. autoclass:: ray.serve.handle.RayServeHandle
|
2020-09-04 12:02:23 -05:00
|
|
|
:members: remote, options
|
2022-05-10 14:04:17 -07:00
|
|
|
```
|
|
|
|
|
|
|
|
## Batching Requests
|
2020-06-15 18:47:59 -07:00
|
|
|
|
2022-05-10 14:04:17 -07:00
|
|
|
```{eval-rst}
|
2021-05-11 03:23:58 -05:00
|
|
|
.. autofunction:: ray.serve.batch(max_batch_size=10, batch_wait_timeout_s=0.0)
|
2022-05-10 14:04:17 -07:00
|
|
|
```
|