xpk 0.14.4__py3-none-any.whl → 0.15.0__py3-none-any.whl

{xpk-0.14.4.dist-info → xpk-0.15.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xpk
-Version: 0.14.4
+Version: 0.15.0
 Summary: xpk helps Cloud developers to orchestrate training jobs on accelerators on GKE.
 Author-email: XPK team <xpk-code-reviewers@google.com>
 License: Apache-2.0
@@ -11,6 +11,7 @@ Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: argcomplete==3.6.3
 Requires-Dist: cloud-accelerator-diagnostics==0.1.1
 Requires-Dist: tabulate==0.9.0
 Requires-Dist: ruamel.yaml==0.18.10
@@ -142,6 +143,18 @@ The following tools must be installed:
 - git: [installation instructions](https://git-scm.com/downloads/linux)
 - make: install by running `apt-get -y install make` (`sudo` might be required)
 
+### Additional prerequisites to enable bash completion
+
+- Install [argcomplete](https://pypi.org/project/argcomplete/) globally on your machine.
+  ```shell
+  pip install argcomplete
+  activate-global-python-argcomplete
+  ```
+- Configure `argcomplete` for XPK.
+  ```shell
+  eval "$(register-python-argcomplete xpk)"
+  ```
+
 ## Installation via pip
 
 To install XPK using pip, first install required tools mentioned in [prerequisites](#prerequisites) and [additional prerequisites](#additional-prerequisites-when-installing-from-pip). Then you can install XPK simply by running:
@@ -243,7 +256,7 @@ all zones.
     # Find your reservations
     gcloud compute reservations list --project=$PROJECT_ID
     # Run cluster create with reservation.
-    python3 xpk.py cluster create \
+    xpk cluster create \
     --cluster xpk-test --tpu-type=v5litepod-256 \
     --num-slices=2 \
     --reservation=$RESERVATION_ID
@@ -252,7 +265,7 @@ all zones.
 *   Cluster Create (provision on-demand capacity):
 
     ```shell
-    python3 xpk.py cluster create \
+    xpk cluster create \
     --cluster xpk-test --tpu-type=v5litepod-16 \
     --num-slices=4 --on-demand
     ```
@@ -260,22 +273,30 @@ all zones.
 *   Cluster Create (provision spot / preemptable capacity):
 
     ```shell
-    python3 xpk.py cluster create \
+    xpk cluster create \
     --cluster xpk-test --tpu-type=v5litepod-16 \
     --num-slices=4 --spot
     ```
 
 * Cluster Create (DWS flex queued capacity):
     ```shell
-        python3 xpk.py cluster create \
+        xpk cluster create \
         --cluster xpk-test --tpu-type=v5litepod-16 \
         --num-slices=4 --flex
     ```
 
+*   Cluster Create with CPU and/or memory quota:
+    ```shell
+    xpk cluster create \
+    --cluster xpk-test --tpu-type=v5litepod-16 \
+    --cpu-limit=112 --memory-limit=192Gi \
+    --on-demand
+    ```
+
 * Cluster Create for Pathways:
     Pathways compatible cluster can be created using `cluster create-pathways`.
     ```shell
-    python3 xpk.py cluster create-pathways \
+    xpk cluster create-pathways \
     --cluster xpk-pw-test \
     --num-slices=4 --on-demand \
     --tpu-type=v5litepod-16
@@ -285,7 +306,7 @@ all zones.
 *   Cluster Create for Ray:
     A cluster with KubeRay enabled and a RayCluster can be created using `cluster create-ray`.
     ```shell
-    python3 xpk.py cluster create-ray \
+    xpk cluster create-ray \
     --cluster xpk-rc-test \
     --ray-version=2.39.0 \
     --num-slices=4 --on-demand \
@@ -298,7 +319,7 @@ all zones.
     For example, if a user creates a cluster with 4 slices:
 
     ```shell
-    python3 xpk.py cluster create \
+    xpk cluster create \
     --cluster xpk-test --tpu-type=v5litepod-16 \
     --num-slices=4  --reservation=$RESERVATION_ID
     ```
@@ -307,7 +328,7 @@ all zones.
     new slices:
 
     ```shell
-    python3 xpk.py cluster create \
+    xpk cluster create \
     --cluster xpk-test --tpu-type=v5litepod-16 \
     --num-slices=8  --reservation=$RESERVATION_ID
     ```
@@ -317,13 +338,13 @@ all zones.
     Use `--force` to skip prompts.
 
     ```shell
-    python3 xpk.py cluster create \
+    xpk cluster create \
     --cluster xpk-test --tpu-type=v5litepod-16 \
     --num-slices=6  --reservation=$RESERVATION_ID
 
     # Skip delete prompts using --force.
 
-    python3 xpk.py cluster create --force \
+    xpk cluster create --force \
     --cluster xpk-test --tpu-type=v5litepod-16 \
     --num-slices=6  --reservation=$RESERVATION_ID
     ```
@@ -333,13 +354,13 @@ all zones.
     user when deleting slices. Use `--force` to skip prompts.
 
     ```shell
-    python3 xpk.py cluster create \
+    xpk cluster create \
     --cluster xpk-test --tpu-type=v4-8 \
     --num-slices=4  --reservation=$RESERVATION_ID
 
     # Skip delete prompts using --force.
 
-    python3 xpk.py cluster create --force \
+    xpk cluster create --force \
     --cluster xpk-test --tpu-type=v4-8 \
     --num-slices=4  --reservation=$RESERVATION_ID
     ```
@@ -370,7 +391,7 @@ This argument allows you to specify additional IP ranges (in CIDR notation) that
 * To create a private cluster and allow access to Control Plane only to your current machine:
 
   ```shell
-  python3 xpk.py cluster create \
+  xpk cluster create \
     --cluster=xpk-private-cluster \
     --tpu-type=v4-8 --num-slices=2 \
     --private
@@ -379,7 +400,7 @@ This argument allows you to specify additional IP ranges (in CIDR notation) that
 * To create a private cluster and allow access to Control Plane only to your current machine and the IP ranges `1.2.3.0/24` and `1.2.4.5/32`:
 
   ```shell
-  python3 xpk.py cluster create \
+  xpk cluster create \
     --cluster=xpk-private-cluster \
     --tpu-type=v4-8 --num-slices=2 \
     --authorized-networks 1.2.3.0/24 1.2.4.5/32
@@ -405,7 +426,7 @@ You can create a Vertex AI Tensorboard for your cluster with `Cluster Create` co
 * Create Vertex AI Tensorboard in default region with default Tensorboard name:
 
 ```shell
-python3 xpk.py cluster create \
+xpk cluster create \
 --cluster xpk-test --num-slices=1 --tpu-type=v4-8 \
 --create-vertex-tensorboard
 ```
@@ -415,7 +436,7 @@ will create a Vertex AI Tensorboard with the name `xpk-test-tb-instance` (*<args
 * Create Vertex AI Tensorboard in user-specified region with default Tensorboard name:
 
 ```shell
-python3 xpk.py cluster create \
+xpk cluster create \
 --cluster xpk-test --num-slices=1 --tpu-type=v4-8 \
 --create-vertex-tensorboard --tensorboard-region=us-west1
 ```
@@ -425,7 +446,7 @@ will create a Vertex AI Tensorboard with the name `xpk-test-tb-instance` (*<args
 * Create Vertex AI Tensorboard in default region with user-specified Tensorboard name:
 
 ```shell
-python3 xpk.py cluster create \
+xpk cluster create \
 --cluster xpk-test --num-slices=1 --tpu-type=v4-8 \
 --create-vertex-tensorboard --tensorboard-name=tb-testing
 ```
@@ -435,7 +456,7 @@ will create a Vertex AI Tensorboard with the name `tb-testing` in `us-central1`.
 * Create Vertex AI Tensorboard in user-specified region with user-specified Tensorboard name:
 
 ```shell
-python3 xpk.py cluster create \
+xpk cluster create \
 --cluster xpk-test --num-slices=1 --tpu-type=v4-8 \
 --create-vertex-tensorboard --tensorboard-region=us-west1 --tensorboard-name=tb-testing
 ```
@@ -445,7 +466,7 @@ will create a Vertex AI Tensorboard instance with the name `tb-testing` in `us-w
 * Create Vertex AI Tensorboard in an unsupported region:
 
 ```shell
-python3 xpk.py cluster create \
+xpk cluster create \
 --cluster xpk-test --num-slices=1 --tpu-type=v4-8 \
 --create-vertex-tensorboard --tensorboard-region=us-central2
 ```
@@ -456,20 +477,20 @@ will fail the cluster creation process because Vertex AI Tensorboard is not supp
 *   Cluster Delete (deprovision capacity):
 
     ```shell
-    python3 xpk.py cluster delete \
+    xpk cluster delete \
     --cluster xpk-test
     ```
 ## Cluster List
 *   Cluster List (see provisioned capacity):
 
     ```shell
-    python3 xpk.py cluster list
+    xpk cluster list
     ```
 ## Cluster Describe
 *   Cluster Describe (see capacity):
 
     ```shell
-    python3 xpk.py cluster describe \
+    xpk cluster describe \
     --cluster xpk-test
     ```
 
@@ -477,7 +498,7 @@ will fail the cluster creation process because Vertex AI Tensorboard is not supp
 *   Cluster Cacheimage (enables faster start times):
 
     ```shell
-    python3 xpk.py cluster cacheimage \
+    xpk cluster cacheimage \
     --cluster xpk-test --docker-image gcr.io/your_docker_image \
     --tpu-type=v5litepod-16
     ```
@@ -495,7 +516,7 @@ A4 | `b200-8`
 
 
 ```shell
-python3 xpk.py cluster create \
+xpk cluster create \
   --cluster CLUSTER_NAME --device-type DEVICE_TYPE \
   --zone=$COMPUTE_ZONE  --project=$PROJECT_ID \
   --num-nodes=$NUM_NODES --reservation=$RESERVATION_ID
@@ -520,7 +541,7 @@ Currently `xpk cluster adapt` supports only the following device types:
 
 Example usage: 
 ```shell
-python3 xpk.py cluster adapt \
+xpk cluster adapt \
   --cluster=$CLUSTER_NAME --device-type=$DEVICE_TYPE \
   --zone=$COMPUTE_ZONE  --project=$PROJECT_ID \
   --num-nodes=$NUM_NODES --reservation=$RESERVATION_ID
@@ -542,7 +563,7 @@ To use the GCS FUSE with XPK you need to create a [Storage Bucket](https://conso
 Once it's ready you can use `xpk storage attach` with `--type=gcsfuse` command to attach a FUSE storage instance to your cluster:
 
 ```shell
-python3 xpk.py storage attach test-fuse-storage --type=gcsfuse \
+xpk storage attach test-fuse-storage --type=gcsfuse \
   --project=$PROJECT --cluster=$CLUSTER --zone=$ZONE 
   --mount-point='/test-mount-point' --readonly=false \
   --bucket=test-bucket --size=1 --auto-mount=false
@@ -567,7 +588,7 @@ A Filestore adapter lets you mount and access [Filestore instances](https://clou
 To create and attach a GCP Filestore instance to your cluster use `xpk storage create` command with `--type=gcpfilestore`:
 
 ```shell
-python3 xpk.py storage create test-fs-storage --type=gcpfilestore \
+xpk storage create test-fs-storage --type=gcpfilestore \
   --auto-mount=false --mount-point=/data-fs --readonly=false \
   --size=1024 --tier=BASIC_HDD --access_mode=ReadWriteMany --vol=default \
   --project=$PROJECT --cluster=$CLUSTER --zone=$ZONE
@@ -576,7 +597,7 @@ python3 xpk.py storage create test-fs-storage --type=gcpfilestore \
 You can also attach an existing Filestore instance to your cluster using `xpk storage attach` command:
 
 ```shell
-python3 xpk.py storage attach test-fs-storage --type=gcpfilestore \
+xpk storage attach test-fs-storage --type=gcpfilestore \
   --auto-mount=false --mount-point=/data-fs --readonly=false \
   --size=1024 --tier=BASIC_HDD --access_mode=ReadWriteMany --vol=default \
   --project=$PROJECT --cluster=$CLUSTER --zone=$ZONE
@@ -605,7 +626,7 @@ To use the GCS Parallelstore with XPK you need to create a [Parallelstore Instan
 Once it's ready you can use `xpk storage attach` with `--type=parallelstore` command to attach a Parallelstore instance to your cluster. Currently, attaching a Parallelstore is supported only by providing a manifest file.
 
 ```shell
-python3 xpk.py storage attach test-parallelstore-storage --type=parallelstore \
+xpk storage attach test-parallelstore-storage --type=parallelstore \
   --project=$PROJECT --cluster=$CLUSTER --zone=$ZONE \
   --mount-point='/test-mount-point' --readonly=false \
   --auto-mount=true \
@@ -629,7 +650,7 @@ To use the GCE PersistentDisk with XPK you need to create a [disk in GCE](https:
 Once it's ready you can use `xpk storage attach` with `--type=pd` command to attach a PersistentDisk instance to your cluster. Currently, attaching a PersistentDisk is supported only by providing a manifest file.
 
 ```shell
-python3 xpk.py storage attach test-pd-storage --type=pd \
+xpk storage attach test-pd-storage --type=pd \
   --project=$PROJECT --cluster=$CLUSTER --zone=$ZONE \
   --mount-point='/test-mount-point' --readonly=false \
   --auto-mount=true \
@@ -653,7 +674,7 @@ To use the GCP Managed Lustre with XPK you need to create [an instance](https://
 Once it's ready you can use `xpk storage attach` with `--type=lustre` command to attach a Managed Lustre instance to your cluster. Currently, attaching a Managed Lustre instance is supported only by providing a manifest file.
 
 ```shell
-python3 xpk.py storage attach test-lustre-storage --type=lustre \
+xpk storage attach test-lustre-storage --type=lustre \
   --project=$PROJECT --cluster=$CLUSTER --zone=$ZONE \
   --mount-point='/test-mount-point' --readonly=false \
   --auto-mount=true \
@@ -671,7 +692,7 @@ Parameters:
 ### List attached storages
 
 ```shell
-python3 xpk.py storage list \
+xpk storage list \
   --project=$PROJECT --cluster $CLUSTER --zone=$ZONE
 ```
 
@@ -680,7 +701,7 @@ python3 xpk.py storage list \
 If you specified `--auto-mount=true` when creating or attaching a storage, then all workloads deployed on the cluster will have the volume attached by default. Otherwise, in order to have the storage attached, you have to add `--storage` parameter to `workload create` command:
 
 ```shell
-python3 xpk.py workload create \
+xpk workload create \
   --workload xpk-test-workload --command "echo goodbye" \
   --project=$PROJECT --cluster=$CLUSTER --zone=$ZONE \
   --tpu-type=v5litepod-16 --storage=test-storage
@@ -689,7 +710,7 @@ python3 xpk.py workload create \
 ### Detaching storage
 
 ```shell
-python3 xpk.py storage detach $STORAGE_NAME \
+xpk storage detach $STORAGE_NAME \
   --project=$PROJECT --cluster=$CLUSTER --zone=$ZONE
 ```
 
@@ -698,7 +719,7 @@ python3 xpk.py storage detach $STORAGE_NAME \
 XPK allows you to remove Filestore instances easily with `xpk storage delete` command. **Warning:** this deletes all data contained in the Filestore!
 
 ```shell
-python3 xpk.py storage delete test-fs-instance \
+xpk storage delete test-fs-instance \
   --project=$PROJECT --cluster=$CLUSTER --zone=$ZONE
 ```
 
@@ -706,14 +727,14 @@ python3 xpk.py storage delete test-fs-instance \
 *   Workload Create (submit training job):
 
     ```shell
-    python3 xpk.py workload create \
+    xpk workload create \
     --workload xpk-test-workload --command "echo goodbye" \
     --cluster xpk-test \
     --tpu-type=v5litepod-16 --project=$PROJECT
     ```
 *   Workload create(DWS flex with queued provisioning):
         ```shell
-    python3 xpk.py workload create \
+    xpk workload create \
     --workload xpk-test-workload --command "echo goodbye" \
     --cluster xpk-test  --flex \
     --tpu-type=v5litepod-16 --project=$PROJECT
@@ -723,7 +744,7 @@ python3 xpk.py storage delete test-fs-instance \
 
     Pathways workload example:
     ```shell
-    python3 xpk.py workload create-pathways \
+    xpk workload create-pathways \
     --workload xpk-pw-test \
     --num-slices=1 \
     --tpu-type=v5litepod-16 \
@@ -737,7 +758,7 @@ python3 xpk.py storage delete test-fs-instance \
 
     Pathways workload example:
     ```shell
-    python3 xpk.py workload create-pathways \
+    xpk workload create-pathways \
     --workload xpk-regular-test \
     --num-slices=1 \
     --tpu-type=v5litepod-16 \
@@ -750,7 +771,7 @@ python3 xpk.py storage delete test-fs-instance \
     Pathways in headless mode - Pathways now offers the capability to run JAX workloads in Vertex AI notebooks or in GCE VMs!
     Specify `--headless` with `workload create-pathways` when the user workload is not provided in a docker container.
     ```shell
-    python3 xpk.py workload create-pathways --headless \
+    xpk workload create-pathways --headless \
     --workload xpk-pw-headless \
     --num-slices=1 \
     --tpu-type=v5litepod-16 \
@@ -785,7 +806,7 @@ A3 Ultra | `h200-141gb-8`
 A4 | `b200-8`
 
 ```shell
-python3 xpk.py workload create \
+xpk workload create \
   --workload=$WORKLOAD_NAME --command="echo goodbye" \
   --cluster=$CLUSTER_NAME --device-type DEVICE_TYPE \
   --zone=$COMPUTE_ZONE  --project=$PROJECT_ID \
@@ -816,7 +837,7 @@ In order to run NCCL test on A3 machines check out [this guide](/examples/nccl/n
 
   #### General Example:
   ```shell
-  python3 xpk.py workload create \
+  xpk workload create \
   --workload xpk-test-medium-workload --command "echo goodbye" --cluster \
   xpk-test --tpu-type=v5litepod-16 --priority=medium
   ```
@@ -833,7 +854,7 @@ XPK will create a Vertex AI Experiment in `workload create` command and attach t
 * Create Vertex AI Experiment with default Experiment name:
 
 ```shell
-python3 xpk.py workload create \
+xpk workload create \
 --cluster xpk-test --workload xpk-workload \
 --use-vertex-tensorboard
 ```
@@ -843,7 +864,7 @@ will create a Vertex AI Experiment with the name `xpk-test-xpk-workload` (*<args
 * Create Vertex AI Experiment with user-specified Experiment name:
 
 ```shell
-python3 xpk.py workload create \
+xpk workload create \
 --cluster xpk-test --workload xpk-workload \
 --use-vertex-tensorboard --experiment-name=test-experiment
 ```
@@ -856,7 +877,7 @@ Check out [MaxText example](https://github.com/google/maxtext/pull/570) on how t
 *   Workload Delete (delete training job):
 
     ```shell
-    python3 xpk.py workload delete \
+    xpk workload delete \
     --workload xpk-test-workload --cluster xpk-test
     ```
 
@@ -865,7 +886,7 @@ Check out [MaxText example](https://github.com/google/maxtext/pull/570) on how t
 *   Workload Delete (delete all training jobs in the cluster):
 
     ```shell
-    python3 xpk.py workload delete \
+    xpk workload delete \
     --cluster xpk-test
     ```
 
@@ -875,7 +896,7 @@ Check out [MaxText example](https://github.com/google/maxtext/pull/570) on how t
     * Filter by Job: `filter-by-job`
 
     ```shell
-    python3 xpk.py workload delete \
+    xpk workload delete \
     --cluster xpk-test --filter-by-job=$USER
     ```
 
@@ -884,7 +905,7 @@ Check out [MaxText example](https://github.com/google/maxtext/pull/570) on how t
     * Filter by Status: `filter-by-status`
 
     ```shell
-    python3 xpk.py workload delete \
+    xpk workload delete \
     --cluster xpk-test --filter-by-status=QUEUED
     ```
 
@@ -894,7 +915,7 @@ Check out [MaxText example](https://github.com/google/maxtext/pull/570) on how t
 *   Workload List (see training jobs):
 
     ```shell
-    python3 xpk.py workload list \
+    xpk workload list \
     --cluster xpk-test
     ```
 
@@ -929,7 +950,7 @@ Check out [MaxText example](https://github.com/google/maxtext/pull/570) on how t
   Filter the workload list by the name of a job.
 
     ```shell
-    python3 xpk.py workload list \
+    xpk workload list \
     --cluster xpk-test --filter-by-job=$USER
     ```
 
@@ -938,14 +959,14 @@ Check out [MaxText example](https://github.com/google/maxtext/pull/570) on how t
   Wait for a job to complete.
 
     ```shell
-    python3 xpk.py workload list \
+    xpk workload list \
     --cluster xpk-test --wait-for-job-completion=xpk-test-workload
     ```
 
   Wait for a job to complete with a timeout of 300 seconds.
 
     ```shell
-    python3 xpk.py workload list \
+    xpk workload list \
     --cluster xpk-test --wait-for-job-completion=xpk-test-workload \
     --timeout=300
     ```
@@ -961,7 +982,7 @@ Check out [MaxText example](https://github.com/google/maxtext/pull/570) on how t
 *   Job List (see jobs submitted via batch command):
 
     ```shell
-    python3 xpk.py job ls --cluster xpk-test
+    xpk job ls --cluster xpk-test
     ```
 
 * Example Job List Output:
@@ -979,7 +1000,7 @@ Check out [MaxText example](https://github.com/google/maxtext/pull/570) on how t
 *   Job Cancel (delete job submitted via batch command):
 
     ```shell
-    python3 xpk.py job cancel xpk-def-app-profile-slurm-74kbv --cluster xpk-test
+    xpk job cancel xpk-def-app-profile-slurm-74kbv --cluster xpk-test
     ```
 
 ## Inspector
@@ -987,7 +1008,7 @@ Check out [MaxText example](https://github.com/google/maxtext/pull/570) on how t
 Inspector output is saved to a file.
 
     ```shell
-    python3 xpk.py inspector \
+    xpk inspector \
       --cluster $CLUSTER_NAME \
       --project $PROJECT_ID \
       --zone $ZONE
@@ -1029,7 +1050,7 @@ Inspector output is saved to a file.
 * `xpk run` lets you execute scripts on a cluster with ease. It automates task execution, handles interruptions, and streams job output to your console.
 
   ```shell
-  python xpk.py run --kind-cluster -n 2 -t 0-2 examples/job.sh 
+  xpk run --kind-cluster -n 2 -t 0-2 examples/job.sh 
   ```
 
 * Example Output:
@@ -1065,7 +1086,7 @@ In order to use XPK for GPU, you can do so by using `device-type` flag.
     gcloud compute reservations list --project=$PROJECT_ID
 
     # Run cluster create with reservation.
-    python3 xpk.py cluster create \
+    xpk cluster create \
     --cluster xpk-test --device-type=h100-80gb-8 \
     --num-nodes=2 \
     --reservation=$RESERVATION_ID
@@ -1074,20 +1095,20 @@ In order to use XPK for GPU, you can do so by using `device-type` flag.
 *   Cluster Delete (deprovision capacity):
 
     ```shell
-    python3 xpk.py cluster delete \
+    xpk cluster delete \
     --cluster xpk-test
     ```
 
 *   Cluster List (see provisioned capacity):
 
     ```shell
-    python3 xpk.py cluster list
+    xpk cluster list
     ```
 
 *   Cluster Describe (see capacity):
 
     ```shell
-    python3 xpk.py cluster describe \
+    xpk cluster describe \
     --cluster xpk-test
     ```
 
@@ -1095,7 +1116,7 @@ In order to use XPK for GPU, you can do so by using `device-type` flag.
 *   Cluster Cacheimage (enables faster start times):
 
     ```shell
-    python3 xpk.py cluster cacheimage \
+    xpk cluster cacheimage \
     --cluster xpk-test --docker-image gcr.io/your_docker_image \
     --device-type=h100-80gb-8
     ```
@@ -1116,7 +1137,7 @@ In order to use XPK for GPU, you can do so by using `device-type` flag.
 
     ```shell
     # Submit a workload
-    python3 xpk.py workload create \
+    xpk workload create \
     --cluster xpk-test --device-type h100-80gb-8 \
     --workload xpk-test-workload \
     --command="echo hello world"
@@ -1125,7 +1146,7 @@ In order to use XPK for GPU, you can do so by using `device-type` flag.
 *   Workload Delete (delete training job):
 
     ```shell
-    python3 xpk.py workload delete \
+    xpk workload delete \
     --workload xpk-test-workload --cluster xpk-test
     ```
 
@@ -1134,7 +1155,7 @@ In order to use XPK for GPU, you can do so by using `device-type` flag.
 *   Workload Delete (delete all training jobs in the cluster):
 
     ```shell
-    python3 xpk.py workload delete \
+    xpk workload delete \
     --cluster xpk-test
     ```
 
@@ -1144,7 +1165,7 @@ In order to use XPK for GPU, you can do so by using `device-type` flag.
     * Filter by Job: `filter-by-job`
 
     ```shell
-    python3 xpk.py workload delete \
+    xpk workload delete \
     --cluster xpk-test --filter-by-job=$USER
     ```
 
@@ -1153,7 +1174,7 @@ In order to use XPK for GPU, you can do so by using `device-type` flag.
     * Filter by Status: `filter-by-status`
 
     ```shell
-    python3 xpk.py workload delete \
+    xpk workload delete \
     --cluster xpk-test --filter-by-status=QUEUED
     ```
 
@@ -1167,7 +1188,7 @@ In order to use XPK for CPU, you can do so by using `device-type` flag.
 
     ```shell
     # Run cluster create with on demand capacity.
-    python3 xpk.py cluster create \
+    xpk cluster create \
     --cluster xpk-test \
     --device-type=n2-standard-32-256 \
     --num-slices=1 \
@@ -1181,7 +1202,7 @@ In order to use XPK for CPU, you can do so by using `device-type` flag.
 
     ```shell
     # Submit a workload
-    python3 xpk.py workload create \
+    xpk workload create \
     --cluster xpk-test \
     --num-slices=1 \
     --device-type=n2-standard-32-256 \
@@ -1211,7 +1232,7 @@ RESERVATION=reservation_id
 PROJECT=my_project
 ZONE=us-east5-b
 
-python3 xpk.py cluster create \
+xpk cluster create \
   --cluster $CLUSTER_NAME \
   --num-slices=$NUM_SLICES \
     --device-type=$DEVICE_TYPE \
@@ -1248,7 +1269,7 @@ RESERVATION=reservation_id
 PROJECT=my_project
 ZONE=us-east5-b
 
-python3 xpk.py cluster create \
+xpk cluster create \
   --cluster $CLUSTER_NAME \
   --num-slices=$NUM_SLICES \
     --device-type=$DEVICE_TYPE \
@@ -1271,7 +1292,7 @@ PROJECT=my_project
 ZONE=us-east5-b
 
 # This will create 2x v4-16 node pools and set the max autoprovisioned chips to 16.
-python3 xpk.py cluster create \
+xpk cluster create \
   --cluster $CLUSTER_NAME \
   --num-slices=$NUM_SLICES \
     --device-type=$DEVICE_TYPE \
@@ -1291,7 +1312,7 @@ PROJECT=my_project
 ZONE=us-east5-b
 
 # This will clear the node pools if they exist in the cluster and set the max autoprovisioned chips to 16
-python3 xpk.py cluster create \
+xpk cluster create \
   --cluster $CLUSTER_NAME \
   --num-slices=$NUM_SLICES \
     --device-type=$DEVICE_TYPE \
@@ -1312,7 +1333,7 @@ Reconfigure the `--device-type` and `--num-slices`
   PROJECT=my_project
   ZONE=us-east5-b
   # Create a 2x v4-8 TPU workload.
-  python3 xpk.py workload create \
+  xpk workload create \
     --cluster $CLUSTER \
     --workload ${USER}-nap-${NUM_SLICES}x${DEVICE_TYPE}_$(date +%H-%M-%S) \
     --command "echo hello world from $NUM_SLICES $DEVICE_TYPE" \
@@ -1325,7 +1346,7 @@ Reconfigure the `--device-type` and `--num-slices`
   DEVICE_TYPE=v4-16
 
   # Create a 1x v4-16 TPU workload.
-  python3 xpk.py workload create \
+  xpk workload create \
     --cluster $CLUSTER \
     --workload ${USER}-nap-${NUM_SLICES}x${DEVICE_TYPE}_$(date +%H-%M-%S) \
     --command "echo hello world from $NUM_SLICES $DEVICE_TYPE" \
@@ -1335,7 +1356,7 @@ Reconfigure the `--device-type` and `--num-slices`
     --project=$PROJECT
 
   # Use a different reservation from what the cluster was created with.
-  python3 xpk.py workload create \
+  xpk workload create \
     --cluster $CLUSTER \
     --workload ${USER}-nap-${NUM_SLICES}x${DEVICE_TYPE}_$(date +%H-%M-%S) \
     --command "echo hello world from $NUM_SLICES $DEVICE_TYPE" \
@@ -1379,19 +1400,19 @@ This flow pulls the `--script-dir` into the `--base-docker-image` and runs the n
 
   - `--script-dir` sets which directory to pull into the image. This defaults to the current working directory.
 
-  See `python3 xpk.py workload create --help` for more info.
+  See `xpk workload create --help` for more info.
 
 * Example with defaults which pulls the local directory into the base image:
   ```shell
   echo -e '#!/bin/bash \n echo "Hello world from a test script!"' > test.sh
-  python3 xpk.py workload create --cluster xpk-test \
+  xpk workload create --cluster xpk-test \
   --workload xpk-test-workload-base-image --command "bash test.sh" \
   --tpu-type=v5litepod-16 --num-slices=1
   ```
 
 * Recommended Flow For Normal Sized Jobs (fewer than 10k accelerators):
   ```shell
-  python3 xpk.py workload create --cluster xpk-test \
+  xpk workload create --cluster xpk-test \
   --workload xpk-test-workload-base-image --command "bash custom_script.sh" \
   --base-docker-image=gcr.io/your_dependencies_docker_image \
   --tpu-type=v5litepod-16 --num-slices=1
@@ -1404,17 +1425,17 @@ workload.
 
 * Running with `--docker-image`:
   ```shell
-  python3 xpk.py workload create --cluster xpk-test \
+  xpk workload create --cluster xpk-test \
   --workload xpk-test-workload-base-image --command "bash test.sh" \
   --tpu-type=v5litepod-16 --num-slices=1 --docker-image=gcr.io/your_docker_image
   ```
 
 * Recommended Flow For Large Sized Jobs (more than 10k accelerators):
   ```shell
-  python3 xpk.py cluster cacheimage \
+  xpk cluster cacheimage \
   --cluster xpk-test --docker-image gcr.io/your_docker_image
   # Run workload create with the same image.
-  python3 xpk.py workload create --cluster xpk-test \
+  xpk workload create --cluster xpk-test \
   --workload xpk-test-workload-base-image --command "bash test.sh" \
   --tpu-type=v5litepod-16 --num-slices=1 --docker-image=gcr.io/your_docker_image
   ```
@@ -1463,7 +1484,7 @@ Please select a CPU type that exists in all zones in the region.
 # Find CPU Types supported in zones.
 gcloud compute machine-types list --zones=$ZONE_LIST
 # Adjust default cpu machine type.
-python3 xpk.py cluster create --default-pool-cpu-machine-type=CPU_TYPE ...
+xpk cluster create --default-pool-cpu-machine-type=CPU_TYPE ...
 ```
 
 ## Workload creation fails
@@ -1472,7 +1493,7 @@ Some XPK cluster configuration might be missing, if workload creation fails with
 
 `[XPK] b'error: the server doesn\'t have a resource type "workloads"\n'`
 
-Mitigate this error by re-running your `xpk.py cluster create ...` command, to refresh the cluster configurations.
+Mitigate this error by re-running your `xpk cluster create ...` command, to refresh the cluster configurations.
 
 ## Permission Issues: `requires one of ["permission_name"] permission(s)`.
 
@@ -1544,7 +1565,7 @@ If error of this kind appeared after updating xpk version it's possible that you
 ## Verbose Logging
 If you are having trouble with your workload, try setting the `--enable-debug-logs` when you schedule it. This will give you more detailed logs to help pinpoint the issue. For example:
 ```shell
-python3 xpk.py workload create \
+xpk workload create \
 --cluster --workload xpk-test-workload \
 --command="echo hello world" --enable-debug-logs
 ```
@@ -1576,7 +1597,7 @@ This configuration will start collecting stack traces inside the `/tmp/debugging
 ### Explore Stack Traces
 To explore the stack traces collected in a temporary directory in Kubernetes Pod, you can run the following command to configure a sidecar container that will read the traces from `/tmp/debugging` directory.
  ```shell
- python3 xpk.py workload create \
+ xpk workload create \
   --workload xpk-test-workload --command "python3 main.py" --cluster \
   xpk-test --tpu-type=v5litepod-16 --deploy-stacktrace-sidecar
  ```
@@ -1587,12 +1608,12 @@ To list available resources and queues use ```xpk info``` command. It allows to
 
 To see queues with usage and workload info use:
 ```shell
-python3 xpk.py info --cluster my-cluster
+xpk info --cluster my-cluster
 ```
 
 You can specify what kind of resources(clusterqueue or localqueue) you want to see using flags --clusterqueue or --localqueue.
 ```shell
-python3 xpk.py info --cluster my-cluster --localqueue
+xpk info --cluster my-cluster --localqueue
 ```
 
 # Local testing with Kind
@@ -1611,7 +1632,7 @@ xpk interfaces seamlessly with kind to manage Kubernetes clusters locally, facil
 *   Cluster create:
 
     ```shell
-    python3 xpk.py kind create \
+    xpk kind create \
     --cluster xpk-test
     ```
 
@@ -1619,7 +1640,7 @@ xpk interfaces seamlessly with kind to manage Kubernetes clusters locally, facil
 *   Cluster Delete:
 
     ```shell
-    python3 xpk.py kind delete \
+    xpk kind delete \
     --cluster xpk-test
     ```
 
@@ -1627,7 +1648,7 @@ xpk interfaces seamlessly with kind to manage Kubernetes clusters locally, facil
 *   Cluster List:
 
     ```shell
-    python3 xpk.py kind list
+    xpk kind list
     ```
 
 ## Local Testing Basics
@@ -1635,7 +1656,7 @@ xpk interfaces seamlessly with kind to manage Kubernetes clusters locally, facil
 Local testing is available exclusively through the `batch` and `job` commands of xpk with the `--kind-cluster` flag. This allows you to simulate training jobs locally:
 
 ```shell
-python xpk.py batch [other-options] --kind-cluster script
+xpk batch [other-options] --kind-cluster script
 ```
 
 Please note that all other xpk subcommands are intended for use with cloud systems on Google Cloud Engine (GCE) and don't support local testing. This includes commands like cluster, info, inspector, etc.