dynamo/lib/bindings/python
Biswa Panda cec19d4db6
feat(perf): add request-plane, transport, and work-handler metric definitions (#6735)
2026-03-14 07:36:31 +00:00
..
codegen feat(perf): add request-plane, transport, and work-handler metric definitions (#6735) 2026-03-14 07:36:31 +00:00
examples feat: split monolithic requirements.txt and remove test deps from runtime image (#6656) 2026-03-10 20:05:12 +00:00
rust feat(kv-router): pluggable scheduling policy for router queue [DYN-2454] (#7260) 2026-03-13 04:16:49 +00:00
src/dynamo feat(perf): add request-plane, transport, and work-handler metric definitions (#6735) 2026-03-14 07:36:31 +00:00
tests test: Fix cancellation test (#7296) 2026-03-12 14:47:26 -04:00
.gitignore chore: rename dynamo (#44) 2025-03-08 01:42:40 -08:00
Cargo.lock feat(kv-router): pluggable scheduling policy for router queue [DYN-2454] (#7260) 2026-03-13 04:16:49 +00:00
Cargo.toml feat(kv-router): package dynamo-kv-indexer binary via maturin [LLM-126] (#7194) 2026-03-12 21:33:11 +00:00
LICENSE build: reorganize python packaging to build new wheels (#118) 2025-03-14 13:43:29 -04:00
README.md docs: restructure docs directory and move fern config to fern/ (#6700) 2026-03-01 19:58:22 -08:00
build.rs chore: allow frontend + mockers to run on macos (#6282) 2026-02-13 19:33:45 +00:00
pyproject.toml chore: bump versions to 1.0.0 (#6613) 2026-02-25 22:42:33 -05: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.