Browse Source

Adding Python API design README

tags/v0.0.0-test.4
haixuanTao 3 years ago
parent
commit
bed3362a67
1 changed files with 14 additions and 0 deletions
  1. +14
    -0
      README.md

+ 14
- 0
README.md View File

@@ -1,2 +1,16 @@
# dora-rs
Dataflow Oriented Robotic Architecture

## Python API Design

The Python API is probably going to look as follows:
```python
@register
async def function_name(state: DoraState, message: DoraMessage):
return outputs
```

The philosophy is to use async function as primary instance to:
- Mitigate the risk of running undafe data mutations.
- Managing several run at the same time with timeout / deadline capabilities
- Using Tokio Spawn to avoid thread locks on CPU bound runs.

Loading…
Cancel
Save