dynamo/lib/bindings/python
Yan Ru Pei 41ff394f51
chore: restructure mocker cli args handling, to include prefill/decode (#3847)
Signed-off-by: PeaBrane <yanrpei@gmail.com>
2025-10-23 10:41:23 -07:00
..
codegen feat: add Rust-to-Python const code generator for prometheus_names.py (#3425) 2025-10-10 11:20:36 -07:00
examples chore: remove kv metrics scraping and aggregation (#3701) 2025-10-17 10:58:48 -07:00
rust chore: restructure mocker cli args handling, to include prefill/decode (#3847) 2025-10-23 10:41:23 -07:00
src/dynamo feat: add TensorRT-LLM Prometheus metrics support with prefixing + filtering (#3676) 2025-10-22 11:25:13 -07:00
tests feat: python gil release for radix tree + dump_tree_as_events in python (#3748) 2025-10-22 01:41:35 +00:00
.gitignore chore: rename dynamo (#44) 2025-03-08 01:42:40 -08:00
Cargo.lock refactor: kvbm modularity DIS-657 Eliminate ETCD from the leader-worker initialization (#3202) 2025-10-23 00:10:09 -07:00
Cargo.toml feat: python package build with abi (cross py3.10+) (#3571) 2025-10-20 12:04:38 -07:00
LICENSE build: reorganize python packaging to build new wheels (#118) 2025-03-14 13:43:29 -04:00
README.md docs: reorganizing documentation to make things clearer (#3658) 2025-10-16 23:59:59 +00:00
pyproject.toml chore: pre-0.6.0 activities (#3592) 2025-10-13 17:45:19 -04:00

README.md

Dynamo Python Bindings

Python bindings for the Dynamo runtime system, enabling distributed computing capabilities for machine learning workloads.

🚀 Quick Start

  1. Install uv: https://docs.astral.sh/uv/#getting-started
curl -LsSf https://astral.sh/uv/install.sh | sh
  1. Install protoc protobuf compiler: https://grpc.io/docs/protoc-installation/.

For example on an Ubuntu/Debian system:

apt install protobuf-compiler
  1. Setup a virtualenv
uv venv
source .venv/bin/activate
uv pip install maturin
  1. Build and install dynamo wheel
maturin develop --uv

Run Examples

Prerequisite

See README.md.

Hello World Example

  1. Start 3 separate shells, and activate the virtual environment in each
source .venv/bin/activate
  1. In one shell (shell 1), run example server the instance-1
python3 ./examples/hello_world/server.py
  1. (Optional) In another shell (shell 2), run example the server instance-2
python3 ./examples/hello_world/server.py
  1. In the last shell (shell 3), run the example client:
python3 ./examples/hello_world/client.py

If you run the example client in rapid succession, and you started more than one server instance above, you should see the requests from the client being distributed across the server instances in each server's output. If only one server instance is started, you should see the requests go to that server each time.

Performance

The performance impacts of synchronizing the Python and Rust async runtimes is a critical consideration when optimizing the performance of a highly concurrent and parallel distributed system.

The Python GIL is a global critical section and is ultimately the death of parallelism. To compound that, when Rust async futures become ready, accessing the GIL on those async event loop needs to be considered carefully. Under high load, accessing the GIL or performing CPU intensive tasks on on the event loop threads can starve out other async tasks for CPU resources. However, performing a tokio::task::spawn_blocking is not without overheads as well.

If bouncing many small message back-and-forth between the Python and Rust event loops where Rust requires GIL access, this is pattern where moving the code from Python to Rust will give you significant gains.