hiro/ray
1
0
Fork 0
mirror of https://github.com/vale981/ray synced 2025-03-06 02:21:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

[Serve] Add deployment graph cookbook (#24524)

Browse source
This commit is contained in:
Sihan Wang 2022-05-11 16:24:55 -07:00 • committed by GitHub
parent 6ea825c294
commit c5bfe1d694
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 668 additions and 553 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/source/_toc.yml
View file

@ -67,6 +67,11 @@ parts:
- file: serve/http-servehandle - file: serve/http-servehandle
- file: serve/ml-models - file: serve/ml-models
- file: serve/deployment-graph - file: serve/deployment-graph
sections:
- file: serve/deployment-graph/deployment-graph-e2e-tutorial
- file: serve/deployment-graph/deployment-graph-user-guides
sections:
- file: serve/deployment-graph/chain_nodes_same_class_different_args
- file: serve/deployment - file: serve/deployment
- file: serve/monitoring - file: serve/monitoring
- file: serve/performance - file: serve/performance

555
doc/source/serve/deployment-graph.md
View file

@ -16,556 +16,5 @@ kernelspec:
# Deployment Graph # Deployment Graph
```{note} - [E2E Tutorials](./deployment-graph/deployment-graph-e2e-tutorial.md)
Note: This feature is in Alpha, so APIs are subject to change. - [User Guides](./deployment-graph/deployment-graph-user-guides.md)
```
## Motivation
Machine learning serving systems are getting longer and wider. They often consist of many models to make a single prediction. This is common in use cases like image / video content classification and tagging, fraud detection pipeline with multiple policies, multi-stage ranking and recommendation, etc.
Meanwhile, the size of a model is also growing beyond the memory limit of a single machine due to the exponentially growing number of parameters. GPT-3 and sparse feature embeddings in large recommendation models are two prime examples.
Ray has unique strengths suited to distributed inference pipelines: flexible scheduling, efficient communication, and shared memory. Ray Serve leverages these strengths to build inference graphs, enabling users to develop complex ML applications locally and then deploy them to production with dynamic scaling and lightweight updates (e.g., for model weights).
## Features
- Provide the ability to build, test, and deploy a complex inference graph of deployments both locally and on remote cluster. The authoring experience is fully Python-programmable and support dynamic control flow and custom business logic, all without writing YAML.
- In production, the deployments making up the graph can be reconfigured and scaled dynamically. This should enable DevOps/MLOps teams to operate deployment graphs without modifying the underlying code.
__[Full Ray Enhancement Proposal, REP-001: Serve Pipeline](https://github.com/ray-project/enhancements/blob/main/reps/2022-03-08-serve_pipeline.md)__
+++
## Concepts
- **Deployment**: Scalable, upgradeable group of actors managed by Ray Serve. __[See docs for detail](https://docs.ray.io/en/master/serve/core-apis.html#core-api-deployments)__
- **DeploymentNode**: Smallest unit in a graph, created by calling `.bind()` on a serve decorated class or function, backed by a Deployment.
- **InputNode**: A special node that represents the input passed to a graph at runtime.
- **Deployment Graph**: Collection of deployment nodes bound together to define an inference graph. The graph can be deployed behind an HTTP endpoint and reconfigured/scaled dynamically.
+++
## Full End to End Example Walkthrough
Let's put the concepts together and incrementally build a runnable DAG example highlighting the following features:
```{tip}
At the end of this document we have the full and end to end executable implementation.
```
- Building a graph:
- A deployment node is created from `@serve.deployment` decorated function or class.
- You can construct different deployment nodes from same class or function.
- Deployment nodes can be used as input args in .bind() of other nodes in the DAG.
- Multiple nodes in the deployment graph naturally forms a DAG structure.
- Accessing input:
- Same input or output can be used in multiple nodes in the DAG.
- Deployment nodes can access partial user input.
- Dynamic control flow:
- A deployment node can call into other nodes in the deployment graph.
- You can use the dynamic calling to perform control flow operation that's hard to expressive in traditional DAG.
- Running a DAG:
- Nodes in the graph, such as functions or class methods, can be either sync or async.
+++
![deployment graph](https://github.com/ray-project/images/blob/master/docs/serve/deployment_graph.png?raw=true)
+++
### Step 1: User InputNode and preprocessor
Let's start with the first layer of DAG: Building user input to two preprocessor functions, where each function receives parts of the input data. For simplicity, we use the same existing `@serve.deployment` decorator on an async function body.
+++
```python
import asyncio
from ray import serve
# We will later move Ray DAG related components
# out of experimental in later stable release
from ray.experimental.dag.input_node import InputNode
@serve.deployment
async def preprocessor(input_data: str):
"""Simple feature processing that converts str to int"""
await asyncio.sleep(0.1) # Manual delay for blocking computation
return int(input_data)
@serve.deployment
async def avg_preprocessor(input_data):
"""Simple feature processing that returns average of input list as float."""
await asyncio.sleep(0.15) # Manual delay for blocking computation
return sum(input_data) / len(input_data)
# DAG building
with InputNode() as dag_input:
# Partial access of user input by index
preprocessed_1 = preprocessor.bind(dag_input[0])
preprocessed_2 = avg_preprocessor.bind(dag_input[1])
```
+++
There are two new APIs used in the DAG building stage: `InputNode()` and `bind()`.
### **```InputNode()```** : User input of the graph
```InputNode``` is a special node in the graph that represents the user input for the graph at runtime. There can only be one for each graph, takes no arguments, and should always be created in a context manager.
It's possible to access partial inputs by index or key if every node in the graph doesn't require the full input. Example: the input consists of `[Tensor_0, Tensor_1]` but a single model might only need to receive `Tensor_1` at rather than the full list.
### **`bind(*args, **kwargs)`** : The graph building API
Once called on supported Ray-decorated function or class (`@serve.deployment` is fully supported, `@ray.remote` will be soon), generates a `DeploymentNode` of type `DAGNode` that acts as the building block of graph building.
In the example above, we can see we're using a context manager to build and bind user input:
```python
with InputNode() as dag_input:
```
Which can be used and accessed by index or key in downstream calls of .bind(), such as:
```python
preprocessed_1 = preprocessor.bind(dag_input[0])
```
This means we're creating a DeploymentNode called `preprocessed_1` in graph building by calling `.bind()` on a serve decorated function, where it executes the decorated deployment function `preprocessor` that takes the user input at index 0 at runtime.
#### bind() on function
```bind()``` on function produces a DeploymentNode that can be executed with user input.
```{tip}
Each deployment node used in graph is individually scalable and configurable by default. This means in real production workload where we can expect difference in compute resource and latency, we can fine tune the nodes to optimal `num_replicas` and `num_cpus` to avoid a single node being the bottleneck of your deployment graph's latency or throughput.
```
#### bind() on class constructor
**`Class.bind(*args, **kwargs)`** constructs and returns a DeploymentNode that acts as the instantiated instance of Class, where `*args` and `**kwargs` are used as init args. In our implementation, we have
```python
m1 = Model.bind(1)
m2 = Model.bind(2)
```
This means we're creating two more `DeploymentNode` of an instance of `Model` that is constructed with init arg of `1` and `2`, and refereced with variable name `m1`, `m2` respectively.
#### bind() on class method
Once a class is bound with its init args, its class methods can be directly accessed, called or bound with other args. It has the same semantics as `bind()` on a function, except it acts on an instantiated `DeploymentNode` class instead.
+++
### Step 2: Model and combiner class instantiation
After we got the preprocessed inputs, we're ready to combine them to construct request object we want to sent to two models instantiated with different initial weights. This means we need:
(1) Two `Model` instances in the graph instantiated with different initial weights
<br>
(2) A `Combiner` that refereces `Model` nodes for its runtime implementation by passing them as init args in `.bind()`
<br>
(3) The ability of `Combiner` to receive and merge preprocessed inputs for the same user input, even they might be produced async and received out of order.
+++
```python
# ... previous nodes implementation skipped
@serve.deployment
class Model:
def __init__(self, weight: int):
self.weight = weight
async def forward(self, input: int):
await asyncio.sleep(0.3) # Manual delay for blocking computation
return f"({self.weight} * {input})"
@serve.deployment
class Combiner:
def __init__(self, m1: Model, m2: Model):
self.m1 = m1
self.m2 = m2
async def run(self, req_part_1, req_part_2, operation):
# Merge model input from two preprocessors
req = f"({req_part_1} + {req_part_2})"
# Submit to both m1 and m2 with same req data in parallel
r1_ref = self.m1.forward.remote(req)
r2_ref = self.m2.forward.remote(req)
# Async gathering of model forward results for same request data
rst = await asyncio.gather(*[r1_ref, r2_ref])
# DAG building
with InputNode() as dag_input:
# Partial access of user input by index
preprocessed_1 = preprocessor.bind(dag_input[0])
preprocessed_2 = avg_preprocessor.bind(dag_input[1])
m1 = Model.bind(1)
m2 = Model.bind(2)
combiner = Combiner.bind(m1, m2)
dag = combiner.run.bind(preprocessed_1, preprocessed_2, dag_input[2])
```
+++
We are adding a few more pieces to our dag builder: `bind()` on class and class method, as well as passing the output of `Model.bind()` as init args into another class `Combiner.bind()`
### DeploymentNode as arguments in other node's bind()
DeploymentNode can also be passed into other `DeploymentNode` in dag binding. In the full example below, ```Combiner``` calls into two instantiations of ```Model``` class, which can be bound and passed into ```Combiner```'s constructor as if we're passing in two regular python class instances.
```python
m1 = Model.bind(1)
m2 = Model.bind(2)
combiner = Combiner.bind(m1, m2)
```
Similarly, we can also pass and bind upstream `DeploymentNode` results that will be resolved upon runtime to downstream DeploymentNodes, in our example, a function `run()` that access class method of ```Combiner``` class takes two preprocessing `DeploymentNode`s' output as well as part of user input that will be resolved when upstream `DeploymentNode` are executed.
```python
preprocessed_1 = preprocessor.bind(dag_input[0])
preprocessed_2 = avg_preprocessor.bind(dag_input[1])
...
dag = combiner.run.bind(preprocessed_1, preprocessed_2, dag_input[2])
```
```{tip}
At runtime, calls of deployment node like ` self.m1.forward.remote()` will be automatically replaced with a `.remote()` call to the deployment handle to `self.m1`.
```
+++
### Step 3: Dynamic aggregation based on user input
Now we have the backbone of our DAG setup: splitting and preprocessing user inputs, aggregate into new request data and send to multiple models downstream. Let's add a bit more dynamic flavor in it to demostrate deployment graph is fully python programmable by introducing control flow based on user input.
It's as simple as adding a plain `if / else` on `combiner.run()`, and from our previous binding, we get `operation` field at runtime from user provided input data.
```python
dag = combiner.run.bind(preprocessed_1, preprocessed_2, dag_input[2])
```
+++
```python
@serve.deployment
class Combiner:
...
async def run(self, req_part_1, req_part_2, operation):
# Merge model input from two preprocessors
req = f"({req_part_1} + {req_part_2})"
# Submit to both m1 and m2 with same req data in parallel
r1_ref = self.m1.forward.remote(req)
r2_ref = self.m2.forward.remote(req)
# Async gathering of model forward results for same request data
rst = await asyncio.gather(*[r1_ref, r2_ref])
# Control flow that determines runtime behavior based on user input
if operation == "sum":
return f"sum({rst})"
else:
return f"max({rst})"
```
+++
```{tip}
Support control flow in plain python code can be very useful to build dynamic dispatcher, such as routing user request to a smaller subset of running models based on request attribute, where each model can be sharded and scaled independently.
```
+++
### Step 4: Driver deployment to handle http ingress
Now we've built the entire serve DAG with the topology, args binding and user input. It's time to add the last piece for serve -- a Driver deployment to expose and configure http. We can configure it to start with two replicas in case the ingress of deployment becomes bottleneck of the DAG.
Serve provides a default DAGDriver implementation that accepts HTTP request and orchestrate the deployment graph execution. You can import it from `from ray.serve.drivers import DAGDriver`.
You can configure how does the DAGDriver convert HTTP request types. By default, we directly send in a [```starlette.requests.Request```](https://www.starlette.io/requests/) object to represent the whole request. You can also specifies built-in adapters. In this example, we will use a `json_request` adapter that parses HTTP body with JSON parser.
```{tip}
There are several useful adapters like ndarray JSON, image object, etc. You can checkout [the list of adapters here](serve-http-adapters). You can also easily plug in your own adapter by passing in in the ```http_adapter``` field.
```
+++
```python
from ray.serve.drivers import DAGDriver
from ray.serve.http_adapters import json_request
# DAG building
with InputNode() as dag_input:
...
dag = combiner.run.bind(
preprocessed_1, preprocessed_2, dag_input[2] # Partial access of user input by index
)
# Each serve dag has a driver deployment as ingress that can be user provided.
serve_dag = DAGDriver.options(route_prefix="/my-dag", num_replicas=2).bind(
dag, http_adapter=json_request
)
```
+++
````{note}
Even though we provide a default `DAGDriver`, you don't have to use it in your Serve DAG. You can easily bring your own Serve deployment to act as the root node. You can find more information about configuring HTTP deployment at {ref}`serve-http`. For example, a simple DAG Driver that parse JSON input can be implemented as follows:
```python
@serve.deployment(route_prefix="/my-dag")
class MyDAGDriver:
def __init__(self, dag_handle):
self.dag_handle = dag_handle
async def predict(self, inp):
"""Perform inference directly without HTTP."""
return await self.dag_handle.remote(inp)
async def __call__(self, request: starlette.requests.Request):
"""HTTP endpoint of the DAG."""
input_data = await request.json()
return await self.predict(input_data)
# DAG building
with InputNode() as dag_input:
...
dag = combiner.run.bind(...)
serve_dag = MyDAGDriver.bind(dag)
```
````
### Step 5: Test the full DAG in both python and http
We can now test and deploy the graph using `serve.run`:
+++
### **```serve.run()```** : running the deployment graph
The deployment graph can be deployed with ```serve.run()```. It
takes in a target `DeploymentNode`, and it deploys the node's deployments, as
well as all its child nodes' deployments. To deploy your graph, pass in the
root DeploymentNode into ```serve.run()```:
```python
with InputNode() as dag_input:
serve_dag = ...
dag_handle = serve.run(serve_dag)
```
```serve.run()``` returns the passed-in node's deployment's handle. You can use
this handle to issue requests to the deployment:
```python
ray.get(dag_handle.remote(user_input))
```
During development, you can also use the Serve CLI to run your deployment
graph. The CLI was included with Serve when you did ``pip install "ray[serve]"``.
The command ```serve run [node import path]``` will deploy the node and its
childrens' deployments. For example, we can remove the ```serve.run()``` calls
inside the Python script and save our example pipeline to a file called
example.py. Then we can run the driver DeploymentNode using its import path,
```example.serve_dag```:
```bash
$ serve run example.serve_dag
```
+++
```{tip}
The CLI expects the import path to either be a Python module on your system
or a relative import from the command line's current working directory. You can
change the directory that the CLI searches using the ```--app-dir``` flag.
The command will block on the terminal window and periodically print all the
deployments' health statuses. You can open a separate terminal window and
issue HTTP requests to your deployments
```
+++
```bash
$ python
>>> import requests
>>> requests.post("http://127.0.0.1:8000/my-dag", json=["1", [0, 2], "max"]).text
```
The CLI's ```serve run``` tool has useful flags to configure which Ray cluster
to run on, which runtime_env to use, and more. Use ```serve run --help``` to get
more info on these options.
+++
## Full End to End Example Code
Now we're done! The full example below covers the full example for you to try out.
```{code-cell} ipython3
import time
import asyncio
import requests
import starlette
import ray
from ray import serve
from ray.experimental.dag.input_node import InputNode
from ray.serve.drivers import DAGDriver
from ray.serve.http_adapters import json_request
ray.init(num_cpus=16)
serve.start()
@serve.deployment
async def preprocessor(input_data: str):
"""Simple feature processing that converts str to int"""
await asyncio.sleep(0.1) # Manual delay for blocking computation
return int(input_data)
@serve.deployment
async def avg_preprocessor(input_data):
"""Simple feature processing that returns average of input list as float."""
await asyncio.sleep(0.15) # Manual delay for blocking computation
return sum(input_data) / len(input_data)
@serve.deployment
class Model:
def __init__(self, weight: int):
self.weight = weight
async def forward(self, input: int):
await asyncio.sleep(0.3) # Manual delay for blocking computation
return f"({self.weight} * {input})"
@serve.deployment
class Combiner:
def __init__(self, m1: Model, m2: Model):
self.m1 = m1
self.m2 = m2
async def run(self, req_part_1, req_part_2, operation):
# Merge model input from two preprocessors
req = f"({req_part_1} + {req_part_2})"
# Submit to both m1 and m2 with same req data in parallel
r1_ref = self.m1.forward.remote(req)
r2_ref = self.m2.forward.remote(req)
# Async gathering of model forward results for same request data
rst = await asyncio.gather(r1_ref, r2_ref)
# Control flow that determines runtime behavior based on user input
if operation == "sum":
return f"sum({rst})"
else:
return f"max({rst})"
# DAG building
with InputNode() as dag_input:
# Partial access of user input by index
preprocessed_1 = preprocessor.bind(dag_input[0])
preprocessed_2 = avg_preprocessor.bind(dag_input[1])
# Multiple instantiation of the same class with different args
m1 = Model.bind(1)
m2 = Model.bind(2)
# Use other DeploymentNode in bind()
combiner = Combiner.bind(m1, m2)
# Use output of function DeploymentNode in bind()
dag = combiner.run.bind(
preprocessed_1, preprocessed_2, dag_input[2]
)
# Each serve dag has a driver deployment as ingress that can be user provided.
serve_dag = DAGDriver.options(route_prefix="/my-dag", num_replicas=2).bind(
dag, http_adapter=json_request
)
dag_handle = serve.run(serve_dag)
# Warm up
ray.get(dag_handle.predict.remote(["0", [0, 0], "sum"]))
# Python handle
cur = time.time()
print(ray.get(dag_handle.predict.remote(["5", [1, 2], "sum"])))
print(f"Time spent: {round(time.time() - cur, 2)} secs.")
# Http endpoint
cur = time.time()
print(requests.post("http://127.0.0.1:8000/my-dag", json=["5", [1, 2], "sum"]).text)
print(f"Time spent: {round(time.time() - cur, 2)} secs.")
# Python handle
cur = time.time()
print(ray.get(dag_handle.predict.remote(["1", [0, 2], "max"])))
print(f"Time spent: {round(time.time() - cur, 2)} secs.")
# Http endpoint
cur = time.time()
print(requests.post("http://127.0.0.1:8000/my-dag", json=["1", [0, 2], "max"]).text)
print(f"Time spent: {round(time.time() - cur, 2)} secs.")
```
## Outputs
```
sum(['(1 * (5 + 1.5))', '(2 * (5 + 1.5))'])
Time spent: 0.49 secs.
sum(['(1 * (5 + 1.5))', '(2 * (5 + 1.5))'])
Time spent: 0.49 secs.
max(['(1 * (1 + 1.0))', '(2 * (1 + 1.0))'])
Time spent: 0.48 secs.
max(['(1 * (1 + 1.0))', '(2 * (1 + 1.0))'])
Time spent: 0.48 secs.
```
Critical path for each request in the DAG is
preprocessing: ```max(preprocessor, avg_preprocessor) = 0.15 secs```
<br>
model forward: ```max(m1.forward, m2.forward) = 0.3 secs```
<br>
<br>
Total of `0.45` secs.
+++
## Conclusion
We've walked through key concepts and a simple representative example that covers many important details we support in deployment graph building. There're still some rough edges in user experience that we're dedicated to polish in the next a few months, so please reach out to us if you have any feedback or suggestions:
- __[Ray Serve forum](https://discuss.ray.io/c/ray-serve/6)__
- __[Github issues / feature request](https://github.com/ray-project/ray/issues)__ (tag `serve`)
Potential Future improvements:
- `serve.build()` to fulfill the Ops API so user's deployment graph can generate a YAML file for deployment, scaling and reconfiguration.
- Performance optimizations:
- Tuning guide for deployment graph to avoid single node being bottleneck
- Better use of async deployment handle
- Leverage ray shared memory to reduce or eliminate intermediate data transfer
- Static compute graph transformation, fusion and placement based on profiling
- Better UX, such as visualization

25
doc/source/serve/deployment-graph/chain_nodes_same_class_different_args.md Normal file
View file

@ -0,0 +1,25 @@
# Pattern: Chain nodes with same class and different args
The example shows how to chain nodes using the same class and having different args passed in
![pic](https://raw.githubusercontent.com/ray-project/images/master/docs/serve/deployment-graph/chain_nodes_same_class_different_args.svg)
## Code
+++
```{eval-rst}
.. literalinclude:: ../doc_code/deployment_graph_same_class_different_args.py
:language: python
```
## Outputs
The graph will add all nodes weights plus the input (which is 0 in this case).
0(input) + 0(weight) + 1(weight) + 2(weight) = 3
```
3
```
+++

575
doc/source/serve/deployment-graph/deployment-graph-e2e-tutorial.md Normal file
View file

@ -0,0 +1,575 @@
---
jupytext:
formats: ipynb,md:myst
text_representation:
extension: .md
format_name: myst
format_version: 0.13
jupytext_version: 1.13.6
kernelspec:
display_name: Python 3
language: python
name: python3
---
(deployment-graph-e2e-tutorial)=
# Deployment Graph E2E Tutorial
```{note}
Note: This feature is in Alpha, so APIs are subject to change.
```
## Motivation
Machine learning serving systems are getting longer and wider. They often consist of many models to make a single prediction. This is common in use cases like image / video content classification and tagging, fraud detection pipeline with multiple policies, multi-stage ranking and recommendation, etc.
Meanwhile, the size of a model is also growing beyond the memory limit of a single machine due to the exponentially growing number of parameters. GPT-3 and sparse feature embeddings in large recommendation models are two prime examples.
Ray has unique strengths suited to distributed inference pipelines: flexible scheduling, efficient communication, and shared memory. Ray Serve leverages these strengths to build inference graphs, enabling users to develop complex ML applications locally and then deploy them to production with dynamic scaling and lightweight updates (e.g., for model weights).
## Features
- Provide the ability to build, test, and deploy a complex inference graph of deployments both locally and on remote cluster. The authoring experience is fully Python-programmable and support dynamic control flow and custom business logic, all without writing YAML.
- In production, the deployments making up the graph can be reconfigured and scaled dynamically. This should enable DevOps/MLOps teams to operate deployment graphs without modifying the underlying code.
__[Full Ray Enhancement Proposal, REP-001: Serve Pipeline](https://github.com/ray-project/enhancements/blob/main/reps/2022-03-08-serve_pipeline.md)__
+++
## Concepts
- **Deployment**: Scalable, upgradeable group of actors managed by Ray Serve. __[See docs for detail](https://docs.ray.io/en/master/serve/core-apis.html#core-api-deployments)__
- **DeploymentNode**: Smallest unit in a graph, created by calling `.bind()` on a serve decorated class or function, backed by a Deployment.
- **InputNode**: A special node that represents the input passed to a graph at runtime.
- **Deployment Graph**: Collection of deployment nodes bound together to define an inference graph. The graph can be deployed behind an HTTP endpoint and reconfigured/scaled dynamically.
+++
## Full End to End Example Walkthrough
Let's put the concepts together and incrementally build a runnable DAG example highlighting the following features:
```{tip}
At the end of this document we have the full and end to end executable implementation.
```
- Building a graph:
- A deployment node is created from `@serve.deployment` decorated function or class.
- You can construct different deployment nodes from same class or function.
- Deployment nodes can be used as input args in .bind() of other nodes in the DAG.
- Multiple nodes in the deployment graph naturally forms a DAG structure.
- Accessing input:
- Same input or output can be used in multiple nodes in the DAG.
- Deployment nodes can access partial user input.
- Dynamic control flow:
- A deployment node can call into other nodes in the deployment graph.
- You can use the dynamic calling to perform control flow operation that's hard to expressive in traditional DAG.
- Running a DAG:
- Nodes in the graph, such as functions or class methods, can be either sync or async.
+++
![deployment graph](https://github.com/ray-project/images/blob/master/docs/serve/deployment_graph.png?raw=true)
+++
### Step 1: User InputNode and preprocessor
Let's start with the first layer of DAG: Building user input to two preprocessor functions, where each function receives parts of the input data. For simplicity, we use the same existing `@serve.deployment` decorator on an async function body.
+++
```python
import asyncio
from ray import serve
# We will later move Ray DAG related components
# out of experimental in later stable release
from ray.experimental.dag.input_node import InputNode
@serve.deployment
async def preprocessor(input_data: str):
"""Simple feature processing that converts str to int"""
await asyncio.sleep(0.1) # Manual delay for blocking computation
return int(input_data)
@serve.deployment
async def avg_preprocessor(input_data):
"""Simple feature processing that returns average of input list as float."""
await asyncio.sleep(0.15) # Manual delay for blocking computation
return sum(input_data) / len(input_data)
# DAG building
with InputNode() as dag_input:
# Partial access of user input by index
preprocessed_1 = preprocessor.bind(dag_input[0])
preprocessed_2 = avg_preprocessor.bind(dag_input[1])
```
+++
There are two new APIs used in the DAG building stage: `InputNode()` and `bind()`.
### **```InputNode()```** : User input of the graph
```InputNode``` is a special node in the graph that represents the user input for the graph at runtime. There can only be one for each graph, takes no arguments, and should always be created in a context manager.
It's possible to access partial inputs by index or key if every node in the graph doesn't require the full input. Example: the input consists of `[Tensor_0, Tensor_1]` but a single model might only need to receive `Tensor_1` at rather than the full list.
### **`bind(*args, **kwargs)`** : The graph building API
Once called on supported Ray-decorated function or class (`@serve.deployment` is fully supported, `@ray.remote` will be soon), generates a `DeploymentNode` of type `DAGNode` that acts as the building block of graph building.
In the example above, we can see we're using a context manager to build and bind user input:
```python
with InputNode() as dag_input:
```
Which can be used and accessed by index or key in downstream calls of .bind(), such as:
```python
preprocessed_1 = preprocessor.bind(dag_input[0])
```
This means we're creating a DeploymentNode called `preprocessed_1` in graph building by calling `.bind()` on a serve decorated function, where it executes the decorated deployment function `preprocessor` that takes the user input at index 0 at runtime.
#### bind() on function
```bind()``` on function produces a DeploymentNode that can be executed with user input.
```{tip}
Each deployment node used in graph is individually scalable and configurable by default. This means in real production workload where we can expect difference in compute resource and latency, we can fine tune the nodes to optimal `num_replicas` and `num_cpus` to avoid a single node being the bottleneck of your deployment graph's latency or throughput.
```
#### bind() on class constructor
**`Class.bind(*args, **kwargs)`** constructs and returns a DeploymentNode that acts as the instantiated instance of Class, where `*args` and `**kwargs` are used as init args. In our implementation, we have
```python
m1 = Model.bind(1)
m2 = Model.bind(2)
```
This means we're creating two more `DeploymentNode` of an instance of `Model` that is constructed with init arg of `1` and `2`, and refereced with variable name `m1`, `m2` respectively.
#### bind() on class method
Once a class is bound with its init args, its class methods can be directly accessed, called or bound with other args. It has the same semantics as `bind()` on a function, except it acts on an instantiated `DeploymentNode` class instead.
+++
### Step 2: Model and combiner class instantiation
After we got the preprocessed inputs, we're ready to combine them to construct request object we want to sent to two models instantiated with different initial weights. This means we need:
(1) Two `Model` instances in the graph instantiated with different initial weights
<br>
(2) A `Combiner` that refereces `Model` nodes for its runtime implementation by passing them as init args in `.bind()`
<br>
(3) The ability of `Combiner` to receive and merge preprocessed inputs for the same user input, even they might be produced async and received out of order.
+++
```python
# ... previous nodes implementation skipped
@serve.deployment
class Model:
def __init__(self, weight: int):
self.weight = weight
async def forward(self, input: int):
await asyncio.sleep(0.3) # Manual delay for blocking computation
return f"({self.weight} * {input})"
@serve.deployment
class Combiner:
def __init__(self, m1: Model, m2: Model):
self.m1 = m1
self.m2 = m2
async def run(self, req_part_1, req_part_2, operation):
# Merge model input from two preprocessors
req = f"({req_part_1} + {req_part_2})"
# Submit to both m1 and m2 with same req data in parallel
r1_ref = self.m1.forward.remote(req)
r2_ref = self.m2.forward.remote(req)
# Async gathering of model forward results for same request data
rst = await asyncio.gather(*[r1_ref, r2_ref])
# DAG building
with InputNode() as dag_input:
# Partial access of user input by index
preprocessed_1 = preprocessor.bind(dag_input[0])
preprocessed_2 = avg_preprocessor.bind(dag_input[1])
m1 = Model.bind(1)
m2 = Model.bind(2)
combiner = Combiner.bind(m1, m2)
dag = combiner.run.bind(preprocessed_1, preprocessed_2, dag_input[2])
```
+++
We are adding a few more pieces to our dag builder: `bind()` on class and class method, as well as passing the output of `Model.bind()` as init args into another class `Combiner.bind()`
### DeploymentNode as arguments in other node's bind()
DeploymentNode can also be passed into other `DeploymentNode` in dag binding. In the full example below, ```Combiner``` calls into two instantiations of ```Model``` class, which can be bound and passed into ```Combiner```'s constructor as if we're passing in two regular python class instances.
```python
m1 = Model.bind(1)
m2 = Model.bind(2)
combiner = Combiner.bind(m1, m2)
```
Similarly, we can also pass and bind upstream `DeploymentNode` results that will be resolved upon runtime to downstream DeploymentNodes, in our example, a function `run()` that access class method of ```Combiner``` class takes two preprocessing `DeploymentNode`s' output as well as part of user input that will be resolved when upstream `DeploymentNode` are executed.
```python
preprocessed_1 = preprocessor.bind(dag_input[0])
preprocessed_2 = avg_preprocessor.bind(dag_input[1])
...
dag = combiner.run.bind(preprocessed_1, preprocessed_2, dag_input[2])
```
```{tip}
At runtime, calls of deployment node like ` self.m1.forward.remote()` will be automatically replaced with a `.remote()` call to the deployment handle to `self.m1`.
```
+++
### Step 3: Dynamic aggregation based on user input
Now we have the backbone of our DAG setup: splitting and preprocessing user inputs, aggregate into new request data and send to multiple models downstream. Let's add a bit more dynamic flavor in it to demostrate deployment graph is fully python programmable by introducing control flow based on user input.
It's as simple as adding a plain `if / else` on `combiner.run()`, and from our previous binding, we get `operation` field at runtime from user provided input data.
```python
dag = combiner.run.bind(preprocessed_1, preprocessed_2, dag_input[2])
```
+++
```python
@serve.deployment
class Combiner:
...
async def run(self, req_part_1, req_part_2, operation):
# Merge model input from two preprocessors
req = f"({req_part_1} + {req_part_2})"
# Submit to both m1 and m2 with same req data in parallel
r1_ref = self.m1.forward.remote(req)
r2_ref = self.m2.forward.remote(req)
# Async gathering of model forward results for same request data
rst = await asyncio.gather(*[r1_ref, r2_ref])
# Control flow that determines runtime behavior based on user input
if operation == "sum":
return f"sum({rst})"
else:
return f"max({rst})"
```
+++
```{tip}
Support control flow in plain python code can be very useful to build dynamic dispatcher, such as routing user request to a smaller subset of running models based on request attribute, where each model can be sharded and scaled independently.
```
+++
### Step 4: Driver deployment to handle http ingress
Now we've built the entire serve DAG with the topology, args binding and user input. It's time to add the last piece for serve -- a Driver deployment to expose and configure http. We can configure it to start with two replicas in case the ingress of deployment becomes bottleneck of the DAG.
Serve provides a default DAGDriver implementation that accepts HTTP request and orchestrate the deployment graph execution. You can import it from `from ray.serve.drivers import DAGDriver`.
You can configure how does the DAGDriver convert HTTP request types. By default, we directly send in a [```starlette.requests.Request```](https://www.starlette.io/requests/) object to represent the whole request. You can also specifies built-in adapters. In this example, we will use a `json_request` adapter that parses HTTP body with JSON parser.
```{tip}
There are several useful adapters like ndarray JSON, image object, etc. You can checkout [the list of adapters here](serve-http-adapters). You can also easily plug in your own adapter by passing in in the ```http_adapter``` field.
```
+++
```python
from ray.serve.drivers import DAGDriver
from ray.serve.http_adapters import json_request
# DAG building
with InputNode() as dag_input:
...
dag = combiner.run.bind(
preprocessed_1, preprocessed_2, dag_input[2] # Partial access of user input by index
)
# Each serve dag has a driver deployment as ingress that can be user provided.
serve_dag = DAGDriver.options(route_prefix="/my-dag", num_replicas=2).bind(
dag, http_adapter=json_request
)
```
+++
````{note}
Even though we provide a default `DAGDriver`, you don't have to use it in your Serve DAG. You can easily bring your own Serve deployment to act as the root node. You can find more information about configuring HTTP deployment at {ref}`serve-http`. For example, a simple DAG Driver that parse JSON input can be implemented as follows:
```python
@serve.deployment(route_prefix="/my-dag")
class MyDAGDriver:
def __init__(self, dag_handle):
self.dag_handle = dag_handle
async def predict(self, inp):
"""Perform inference directly without HTTP."""
return await self.dag_handle.remote(inp)
async def __call__(self, request: starlette.requests.Request):
"""HTTP endpoint of the DAG."""
input_data = await request.json()
return await self.predict(input_data)
# DAG building
with InputNode() as dag_input:
...
dag = combiner.run.bind(...)
serve_dag = MyDAGDriver.bind(dag)
```
````
### Step 5: Test the full DAG in both python and http
We can now test and deploy the graph using `serve.run`:
+++
### **```serve.run()```** : running the deployment graph
The deployment graph can be deployed with ```serve.run()```. It
takes in a target `DeploymentNode`, and it deploys the node's deployments, as
well as all its child nodes' deployments. To deploy your graph, pass in the
root DeploymentNode into ```serve.run()```:
```python
with InputNode() as dag_input:
serve_dag = ...
dag_handle = serve.run(serve_dag)
```
```serve.run()``` returns the passed-in node's deployment's handle. You can use
this handle to issue requests to the deployment:
```python
ray.get(dag_handle.remote(user_input))
```
During development, you can also use the Serve CLI to run your deployment
graph. The CLI was included with Serve when you did ``pip install "ray[serve]"``.
The command ```serve run [node import path]``` will deploy the node and its
childrens' deployments. For example, we can remove the ```serve.run()``` calls
inside the Python script and save our example pipeline to a file called
example.py. Then we can run the driver DeploymentNode using its import path,
```example.serve_dag```:
```bash
$ serve run example.serve_dag
```
+++
```{tip}
The CLI expects the import path to either be a Python module on your system
or a relative import from the command line's current working directory. You can
change the directory that the CLI searches using the ```--app-dir``` flag.
The command will block on the terminal window and periodically print all the
deployments' health statuses. You can open a separate terminal window and
issue HTTP requests to your deployments
```
+++
```bash
$ python
>>> import requests
>>> requests.post("http://127.0.0.1:8000/my-dag", json=["1", [0, 2], "max"]).text
```
The CLI's ```serve run``` tool has useful flags to configure which Ray cluster
to run on, which runtime_env to use, and more. Use ```serve run --help``` to get
more info on these options.
+++
## Full End to End Example Code
Now we're done! The full example below covers the full example for you to try out.
```{code-cell} ipython3
import time
import asyncio
import requests
import starlette
import ray
from ray import serve
from ray.experimental.dag.input_node import InputNode
from ray.serve.drivers import DAGDriver
from ray.serve.http_adapters import json_request
ray.init(num_cpus=16)
serve.start()
@serve.deployment
async def preprocessor(input_data: str):
"""Simple feature processing that converts str to int"""
await asyncio.sleep(0.1) # Manual delay for blocking computation
return int(input_data)
@serve.deployment
async def avg_preprocessor(input_data):
"""Simple feature processing that returns average of input list as float."""
await asyncio.sleep(0.15) # Manual delay for blocking computation
return sum(input_data) / len(input_data)
@serve.deployment
class Model:
def __init__(self, weight: int):
self.weight = weight
async def forward(self, input: int):
await asyncio.sleep(0.3) # Manual delay for blocking computation
return f"({self.weight} * {input})"
@serve.deployment
class Combiner:
def __init__(self, m1: Model, m2: Model):
self.m1 = m1
self.m2 = m2
async def run(self, req_part_1, req_part_2, operation):
# Merge model input from two preprocessors
req = f"({req_part_1} + {req_part_2})"
# Submit to both m1 and m2 with same req data in parallel
r1_ref = self.m1.forward.remote(req)
r2_ref = self.m2.forward.remote(req)
# Async gathering of model forward results for same request data
rst = await asyncio.gather(r1_ref, r2_ref)
# Control flow that determines runtime behavior based on user input
if operation == "sum":
return f"sum({rst})"
else:
return f"max({rst})"
# DAG building
with InputNode() as dag_input:
# Partial access of user input by index
preprocessed_1 = preprocessor.bind(dag_input[0])
preprocessed_2 = avg_preprocessor.bind(dag_input[1])
# Multiple instantiation of the same class with different args
m1 = Model.bind(1)
m2 = Model.bind(2)
# Use other DeploymentNode in bind()
combiner = Combiner.bind(m1, m2)
# Use output of function DeploymentNode in bind()
dag = combiner.run.bind(
preprocessed_1, preprocessed_2, dag_input[2]
)
# Each serve dag has a driver deployment as ingress that can be user provided.
serve_dag = DAGDriver.options(route_prefix="/my-dag", num_replicas=2).bind(
dag, http_adapter=json_request
)
dag_handle = serve.run(serve_dag)
# Warm up
ray.get(dag_handle.predict.remote(["0", [0, 0], "sum"]))
# Python handle
cur = time.time()
print(ray.get(dag_handle.predict.remote(["5", [1, 2], "sum"])))
print(f"Time spent: {round(time.time() - cur, 2)} secs.")
# Http endpoint
cur = time.time()
print(requests.post("http://127.0.0.1:8000/my-dag", json=["5", [1, 2], "sum"]).text)
print(f"Time spent: {round(time.time() - cur, 2)} secs.")
# Python handle
cur = time.time()
print(ray.get(dag_handle.predict.remote(["1", [0, 2], "max"])))
print(f"Time spent: {round(time.time() - cur, 2)} secs.")
# Http endpoint
cur = time.time()
print(requests.post("http://127.0.0.1:8000/my-dag", json=["1", [0, 2], "max"]).text)
print(f"Time spent: {round(time.time() - cur, 2)} secs.")
```
## Outputs
```
sum(['(1 * (5 + 1.5))', '(2 * (5 + 1.5))'])
Time spent: 0.49 secs.
sum(['(1 * (5 + 1.5))', '(2 * (5 + 1.5))'])
Time spent: 0.49 secs.
max(['(1 * (1 + 1.0))', '(2 * (1 + 1.0))'])
Time spent: 0.48 secs.
max(['(1 * (1 + 1.0))', '(2 * (1 + 1.0))'])
Time spent: 0.48 secs.
```
Critical path for each request in the DAG is
preprocessing: ```max(preprocessor, avg_preprocessor) = 0.15 secs```
<br>
model forward: ```max(m1.forward, m2.forward) = 0.3 secs```
<br>
<br>
Total of `0.45` secs.
+++
## More Examples using deployment graph api
We provide more examples in using the deployment graph api in [here](./deployment-graph-user-guides.md)
## Conclusion
We've walked through key concepts and a simple representative example that covers many important details we support in deployment graph building. There're still some rough edges in user experience that we're dedicated to polish in the next a few months, so please reach out to us if you have any feedback or suggestions:
- __[Ray Serve forum](https://discuss.ray.io/c/ray-serve/6)__
- __[Github issues / feature request](https://github.com/ray-project/ray/issues)__ (tag `serve`)
Potential Future improvements:
- `serve.build()` to fulfill the Ops API so user's deployment graph can generate a YAML file for deployment, scaling and reconfiguration.
- Performance optimizations:
- Tuning guide for deployment graph to avoid single node being bottleneck
- Better use of async deployment handle
- Leverage ray shared memory to reduce or eliminate intermediate data transfer
- Static compute graph transformation, fusion and placement based on profiling
- Better UX, such as visualization

23
doc/source/serve/deployment-graph/deployment-graph-user-guides.md Normal file
View file

@ -0,0 +1,23 @@
---
jupytext:
formats: ipynb,md:myst
text_representation:
extension: .md
format_name: myst
format_version: 0.13
jupytext_version: 1.13.6
kernelspec:
display_name: Python 3
language: python
name: python3
---
(graph-deployment-user-guides)=
# Deployment Graph User Guides
This page is a collections of more common design patterns for using the deployment graph.
## Patterns
- [Chain nodes with same class and different args](./chain_nodes_same_class_different_args.md)

31
doc/source/serve/doc_code/deployment_graph_same_class_different_args.py Normal file
View file

@ -0,0 +1,31 @@
import ray
from ray import serve
from ray.experimental.dag.input_node import InputNode
ray.init()
serve.start()
@serve.deployment
class Model:
def __init__(self, weight):
self.weight = weight
def forward(self, input):
return input + self.weight
# 3 nodes chain in a line
num_nodes = 3
nodes = [Model.bind(w) for w in range(num_nodes)]
outputs = [None] * num_nodes
with InputNode() as dag_input:
for i in range(num_nodes):
if i == 0:
# first node
outputs[i] = nodes[i].forward.bind(dag_input)
else:
outputs[i] = nodes[i].forward.bind(outputs[i - 1])
print(ray.get(outputs[-1].execute(0)))

7
python/ray/serve/BUILD
View file

@ -463,6 +463,13 @@ py_test(
tags = ["exclusive", "team:serve"], tags = ["exclusive", "team:serve"],
) )
py_test(
name = "deployment_graph_same_class_different_args",
size = "small",
srcs = ["//doc/source/serve/doc_code:serve_doc_code"],
tags = ["exclusive", "team:serve"],
)
py_test( py_test(
name = "tutorial_rllib", name = "tutorial_rllib",
size = "small", size = "small",