Skip to content

Commit c6f438d

Browse files
committed
XPK quick guides
1 parent 910ecdd commit c6f438d

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

docs/install_maxtext.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ seed-env \
122122
--output-dir=generated_gpu_artifacts
123123
```
124124

125-
## 4. Update Project Files
125+
## Step 4: Update Project Files
126126

127127
After generating the new requirements, you need to update the files in the MaxText repository.
128128

@@ -133,7 +133,7 @@ After generating the new requirements, you need to update the files in the MaxTe
133133
2. **Update `extra_deps_from_github.txt` (if necessary):**
134134
Currently, MaxText uses a few dependencies, such as `mlperf-logging` and `google-jetstream`, that are installed directly from GitHub source. These are defined in `base_requirements/requirements.txt`, and the `seed-env` tool will carry them over to the generated requirements files.
135135

136-
## 5. Verify the New Dependencies
136+
## Step 5: Verify the New Dependencies
137137

138138
Finally, test that the new dependencies install correctly and that MaxText runs as expected.
139139

@@ -155,4 +155,26 @@ uv pip install -e .[tpu] --resolution=lowest
155155
install_maxtext_github_deps
156156
```
157157

158-
3. **Run tests:** Run MaxText tests to ensure there are no regressions.
158+
3. **Run tests:** Run MaxText tests to ensure there are no regressions.
159+
160+
## Appendix: Install XPK for Multi-host Workloads
161+
162+
XPK (Accelerated Processing Kit) is a tool designed to simplify the orchestration and management of workloads on Google Kubernetes Engine (GKE) clusters with TPU or GPU accelerators. In MaxText, we use XPK to submit both pre-training and post-training jobs on multi-host TPU configurations.
163+
164+
For your convenience, we provide a minimal installation path below:
165+
```bash
166+
# Directly install xpk using pip
167+
pip install xpk
168+
169+
# Install kubectl
170+
sudo apt-get update
171+
sudo apt install snapd
172+
sudo snap install kubectl --classic
173+
174+
# Install gke-gcloud-auth-plugin
175+
echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list
176+
curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key --keyring /usr/share/keyrings/cloud.google.gpg add -
177+
sudo apt update && sudo apt-get install google-cloud-sdk-gke-gcloud-auth-plugin
178+
```
179+
180+
For detailed setup instructions and advanced features, please refer to the [official XPK documentation](https://github.com/AI-Hypercomputer/xpk).

0 commit comments

Comments
 (0)