From c00529535716623e0f5e860db2812267fe925d32 Mon Sep 17 00:00:00 2001 From: "Jason Zhou (Engrg-Hardware 1)" Date: Thu, 17 Sep 2026 06:31:27 -0700 Subject: [PATCH] docs: constrain grpcio-tools in Planner installation examples Signed-off-by: Jason Zhou (Engrg-Hardware 1) --- README.md | 8 +++++++- docs/cli/examples/dynamo-planner/README.md | 11 ++++++++++- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2349f3ad9..e751d915e 100644 --- a/README.md +++ b/README.md @@ -62,11 +62,17 @@ artifacts and their compatible AISimulate wheel: ```bash # Example for Dynamo 1.5.0 RC9; change this to your installed build's revision. DYNAMO_REF=ffd7c1a90eb403c0d43911690c5c9b8457acd826 -python3 -m pip install -r \ +python3 -m pip install "grpcio-tools<=1.76.0" -r \ "https://raw.githubusercontent.com/ai-dynamo/dynamo/${DYNAMO_REF}/container/deps/requirements.planner.txt" python3 -m pip check ``` +The `grpcio-tools` cap matches RC9's +[common requirements](https://github.com/ai-dynamo/dynamo/blob/ffd7c1a90eb403c0d43911690c5c9b8457acd826/container/deps/requirements.common.txt). +It keeps the tooling compatible with Planner's `protobuf==6.33.6` pin. +When selecting another Dynamo revision, check its common requirements and +update this cap together with `DYNAMO_REF`. + For release candidates, use the exact release artifacts; a package version alone may not identify the RC build. Alternatively, use the matching `dynamo-planner` image, which includes the Planner prerequisites. See the diff --git a/docs/cli/examples/dynamo-planner/README.md b/docs/cli/examples/dynamo-planner/README.md index d0ccaeeaa..0a42b10c7 100644 --- a/docs/cli/examples/dynamo-planner/README.md +++ b/docs/cli/examples/dynamo-planner/README.md @@ -36,11 +36,20 @@ requirements from the **same Dynamo tag or commit as those wheels**: ```bash # Dynamo 1.5.0 RC9 example; replace with the revision of your installed build. DYNAMO_REF=ffd7c1a90eb403c0d43911690c5c9b8457acd826 -python3 -m pip install -r \ +python3 -m pip install "grpcio-tools<=1.76.0" -r \ "https://raw.githubusercontent.com/ai-dynamo/dynamo/${DYNAMO_REF}/container/deps/requirements.planner.txt" python3 -m pip check ``` +The `grpcio-tools` cap matches RC9's +[common requirements](https://github.com/ai-dynamo/dynamo/blob/ffd7c1a90eb403c0d43911690c5c9b8457acd826/container/deps/requirements.common.txt). +AISimulate's `google-vizier` dependency can install a newer `grpcio-tools` +that requires a different protobuf version. Include the cap in the same pip +invocation as the Planner requirements so the resolver can select compatible +versions together, including when repairing an existing environment. When +selecting another Dynamo revision, check its common requirements and update +this cap together with `DYNAMO_REF`. + Use the full requirements file, which includes `scikit-learn` and other Planner dependencies. The supported prebuilt alternative is the matching `dynamo-planner` image, which already includes these prerequisites. Use the