Skip to content

Commit 3294239

Browse files
committed
docs(setup_env): show HIGHEST_TORCH_GROUP/LOWEST_TORCH_GROUP usage
Export both from the Makefile so they're available to any Make- invoked subprocess, and reference them via bash fallback expansion in setup_env.sh's help examples instead of hardcoding the literal group names — keeps the documented example in sync with the same alias the Makefile targets already use.
1 parent 5780c1d commit 3294239

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

Makefile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ VENV_TUTORIAL ?= .venv-tutorial
5858
# when the project's torch version bounds change.
5959
HIGHEST_TORCH_GROUP := torch_2_11
6060
LOWEST_TORCH_GROUP := torch_2_8
61+
export HIGHEST_TORCH_GROUP
62+
export LOWEST_TORCH_GROUP
6163

6264
# Torch dependency group (pyproject.toml [dependency-groups]) that every
6365
# environment-building target (env, test, test-smoke, docs, ...) pins to.

scripts/make/setup_env.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,8 @@ show_help() {
136136
echo " $0 --python-version 3.11 # Setup with dev group only"
137137
echo " $0 --python-version 3.11 --with-docs # Setup with dev and docs groups"
138138
echo " $0 --python-version 3.11 --all-groups # Setup with all non-conflicting groups"
139-
echo " TORCH_GROUP=torch_2_11 $0 --python-version 3.11 --all-groups # Setup with all groups and torch 2.11"
140-
echo " TORCH_GROUP=torch_2_8 $0 --python-version 3.11 --all-groups # Setup with all groups and torch 2.8"
139+
echo " TORCH_GROUP=\${HIGHEST_TORCH_GROUP:-torch_2_11} $0 --python-version 3.11 --all-groups # Setup with all groups and the highest torch version"
140+
echo " TORCH_GROUP=\${LOWEST_TORCH_GROUP:-torch_2_8} $0 --python-version 3.11 --all-groups # Setup with all groups and the lowest torch version"
141141
echo " $0 --python-version 3.11 --venv .venv-exp # Setup with custom venv name"
142142
echo " $0 --python-version 3.11 --with-docs --venv .venv-exp # Setup with docs group and custom venv name"
143143
echo " $0 --python-version 3.12 # Setup with Python 3.12"

0 commit comments

Comments
 (0)