Skip to content

Commit 5b0e32b

Browse files
fix: Update TPU 7x README.md (GoogleCloudPlatform#5171)
1 parent f5568c0 commit 5b0e32b

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

examples/gke-tpu-7x/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The blueprint follows Google Cloud best practices, including:
1010

1111
> NOTE: This guide provides examples for deploying a small, single-node slice (2x2x1), but the parameters in the deployment file can be easily changed to provision larger, multi-node slices.
1212
13-
This guide also includes a `tpu-7x-job.yaml` that creates a Kubernetes Pod and runs a simple command to check for available TPU chips.
13+
This guide also includes a `gke-tpu-7x-job.yaml` that creates a Kubernetes Pod and runs a simple command to check for available TPU chips.
1414

1515
## Key parameters when working with TPUs
1616

@@ -126,8 +126,8 @@ The process is nearly identical to the basic deployment.
126126
```sh
127127
cd ~/cluster-toolkit
128128
./gcluster deploy -d \
129-
community/examples/gke-tpu-7x/gke-tpu-7x-deployment.yaml \
130-
community/examples/gke-tpu-7x/gke-tpu-7x-advanced.yaml
129+
examples/gke-tpu-7x/gke-tpu-7x-deployment.yaml \
130+
examples/gke-tpu-7x/gke-tpu-7x-advanced.yaml
131131
```
132132

133133
3. After deployment, the blueprint will output instructions for running a fio benchmark job. This job serves as a validation test to confirm that the GCS mounts are working correctly for both reading and writing. Follow the printed instructions to run the test.
@@ -153,7 +153,7 @@ This blueprint supports [Kueue](https://kueue.sigs.k8s.io/), a kubernetes-native
153153

154154
## Run the sample job
155155

156-
The `tpu-7x-job.yaml` file creates a Pod resource in Kubernetes. The workload installs JAX and a specific `libtpu` library, and then returns the number of TPU chips it can detect.
156+
The `gke-tpu-7x-job.yaml` file creates a Pod resource in Kubernetes. The workload installs JAX and a specific `libtpu` library, and then returns the number of TPU chips it can detect.
157157

158158
1. Connect to your cluster:
159159

@@ -165,7 +165,7 @@ The `tpu-7x-job.yaml` file creates a Pod resource in Kubernetes. The workload in
165165

166166
Replace `DEPLOYMENT_NAME`, `REGION`, and `PROJECT_ID` with the ones used in your `gke-tpu-7x-deployment.yaml` file.
167167
2. Update the `nodeSelector` in the job file.
168-
Open the `examples/gke-tpu-7x/tpu-7x-job.yaml` file. Ensure the `nodeSelector` values match the accelerator label and topology used in your deployment file.
168+
Open the `examples/gke-tpu-7x/gke-tpu-7x-job.yaml` file. Ensure the `nodeSelector` values match the accelerator label and topology used in your deployment file.
169169
> *You can find the correct labels for your cluster by running `kubectl get nodes --show-labels`*
170170

171171
For the example deployment, the values are:
@@ -179,7 +179,7 @@ The `tpu-7x-job.yaml` file creates a Pod resource in Kubernetes. The workload in
179179
3. Update Resource Request:
180180

181181
```yaml
182-
# In tpu-7x-job.yaml, inside the spec container
182+
# In gke-tpu-7x-job.yaml, inside the spec container
183183
resources:
184184
requests:
185185
google.com/tpu: <CHIPS_PER_NODE> # e.g., 4 for tpu7x-standard-4t
@@ -191,7 +191,7 @@ The `tpu-7x-job.yaml` file creates a Pod resource in Kubernetes. The workload in
191191
The sample job file already contains the correct node selectors for the example deployment.
192192

193193
```bash
194-
kubectl create -f ~/cluster-toolkit/examples/gke-tpu-7x/tpu-7x-job.yaml
194+
kubectl create -f ~/cluster-toolkit/examples/gke-tpu-7x/gke-tpu-7x-job.yaml
195195
```
196196

197197
This command returns a Pod name.

0 commit comments

Comments
 (0)