mirror of
https://github.com/vale981/ray
synced 2025-03-11 21:56:39 -04:00
58 lines
No EOL
931 B
Markdown
58 lines
No EOL
931 B
Markdown
(serve-api)=
|
|
# Ray Serve API
|
|
|
|
(core-apis)=
|
|
|
|
## Core APIs
|
|
|
|
```{eval-rst}
|
|
.. autofunction:: ray.serve.run
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autofunction:: ray.serve.start
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autofunction:: ray.serve.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
|
|
:members: remote, options
|
|
```
|
|
|
|
## Batching Requests
|
|
|
|
```{eval-rst}
|
|
.. autofunction:: ray.serve.batch(max_batch_size=10, batch_wait_timeout_s=0.0)
|
|
```
|
|
|
|
## Operational APIs
|
|
|
|
Check out the [CLI](serve-cli) and [REST API](serve-rest-api) for running, debugging, inspecting, and deploying Serve applications in production:
|
|
|
|
```{toctree}
|
|
:maxdepth: 1
|
|
:name: serve-non-python-api
|
|
|
|
serve_cli
|
|
rest_api
|
|
``` |