Skip to content

Commit d1bf1b9

Browse files
authored
[Docs][TPU] Highlight TPU Software version selection (#22242)
Signed-off-by: NickLucche <[email protected]>
1 parent 586f286 commit d1bf1b9

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/getting_started/installation/google_tpu.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ gcloud alpha compute tpus queued-resources create QUEUED_RESOURCE_ID \
8585
| PROJECT_ID | Your Google Cloud project |
8686
| ZONE | The GCP zone where you want to create your Cloud TPU. The value you use depends on the version of TPUs you are using. For more information, see [TPU regions and zones] |
8787
| ACCELERATOR_TYPE | The TPU version you want to use. Specify the TPU version, for example `v5litepod-4` specifies a v5e TPU with 4 cores, `v6e-1` specifies a v6e TPU with 1 core. For more information, see [TPU versions]. |
88-
| RUNTIME_VERSION | The TPU VM runtime version to use. For example, use `v2-alpha-tpuv6e` for a VM loaded with one or more v6e TPU(s). For more information see [TPU VM images]. |
88+
| RUNTIME_VERSION | The TPU VM runtime version to use. For example, use `v2-alpha-tpuv6e` for a VM loaded with one or more v6e TPU(s). |
8989
| SERVICE_ACCOUNT | The email address for your service account. You can find it in the IAM Cloud Console under *Service Accounts*. For example: `tpu-service-account@<your_project_ID>.iam.gserviceaccount.com` |
9090

9191
Connect to your TPU VM using SSH:
@@ -94,6 +94,9 @@ Connect to your TPU VM using SSH:
9494
gcloud compute tpus tpu-vm ssh TPU_NAME --project PROJECT_ID --zone ZONE
9595
```
9696

97+
!!! note
98+
When configuring `RUNTIME_VERSION` ("TPU software version") on GCP, ensure it matches the TPU generation you've selected by referencing the [TPU VM images] compatibility matrix. Using an incompatible version may prevent vLLM from running correctly.
99+
97100
[TPU versions]: https://cloud.google.com/tpu/docs/runtimes
98101
[TPU VM images]: https://cloud.google.com/tpu/docs/runtimes
99102
[TPU regions and zones]: https://cloud.google.com/tpu/docs/regions-zones

0 commit comments

Comments
 (0)