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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

48 lines
733 B
Markdown
Raw Normal View History

# Ray Serve API
## Core APIs
```{eval-rst}
2020-09-04 12:02:23 -05:00
.. autofunction:: ray.serve.start
```
```{eval-rst}
.. autofunction:: ray.serve.deployment
```
```{eval-rst}
.. autofunction:: ray.serve.list_deployments
```
```{eval-rst}
.. autofunction:: ray.serve.get_deployment
```
```{eval-rst}
.. autofunction:: ray.serve.shutdown
```
(deployment-api)=
## Deployment API
```{eval-rst}
.. autoclass:: ray.serve.deployment.Deployment
:members: deploy, delete, options, get_handle
```
(servehandle-api)=
## ServeHandle API
```{eval-rst}
.. autoclass:: ray.serve.handle.RayServeHandle
2020-09-04 12:02:23 -05:00
:members: remote, options
```
## Batching Requests
```{eval-rst}
2021-05-11 03:23:58 -05:00
.. autofunction:: ray.serve.batch(max_batch_size=10, batch_wait_timeout_s=0.0)
```