Skip to content

Add runner installation option to ReadTheDocs #3447

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
copybara-service merged 1 commit into from
Mar 18, 2026
Merged

Add runner installation option to ReadTheDocs #3447

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
7 changes: 7 additions & 0 deletions docs/install_maxtext.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ MaxText offers three installation modes:
1. maxtext[tpu]. Used for pre-training and decode on TPUs.
2. maxtext[cuda12]. Used for pre-training and decode on GPUs.
3. maxtext[tpu-post-train]. Used for post-training on TPUs. Currently, this option should also be used for running vllm_decode on TPUs.
4. maxtext[runner]. Used for building MaxText's Docker images and scheduling workloads through XPK.

## From PyPI (Recommended)

Expand Down Expand Up @@ -49,6 +50,9 @@ install_maxtext_cuda12_github_dep
# Option 3: Installing maxtext[tpu-post-train]
uv pip install "maxtext[tpu-post-train]>=0.2.0" --resolution=lowest
install_maxtext_tpu_post_train_extra_deps

# Option 4: Installing maxtext[runner]
uv pip install maxtext[runner] --resolution=lowest
```

> **Note:** The `install_maxtext_tpu_github_deps`, `install_maxtext_cuda12_github_dep`, and
Expand Down Expand Up @@ -85,6 +89,9 @@ install_maxtext_cuda12_github_dep
# Option 3: Installing .[tpu-post-train]
uv pip install -e .[tpu-post-train] --resolution=lowest
install_maxtext_tpu_post_train_extra_deps

# Option 4: Installing maxtext[runner]
uv pip install .[runner] --resolution=lowest
```

After installation, you can verify the package is available with `python3 -c "import maxtext"` and run training jobs with `python3 -m maxtext.trainers.pre_train.train ...`.
Expand Down
Loading