Skip to content

docs: constrain grpcio-tools in Planner installation examples #249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
simone-chen merged 1 commit into from
Sep 17, 2026
Merged

docs: constrain grpcio-tools in Planner installation examples #249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 10 additions & 1 deletion docs/cli/examples/dynamo-planner/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down