xpk 0.1.0__tar.gz

xpk-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

xpk-0.1.0/PKG-INFO

@@ -0,0 +1,334 @@
+Metadata-Version: 2.1
+Name: xpk
+Version: 0.1.0
+Summary: xpk helps Cloud developers to orchestrate training jobs on accelerators on GKE.
+Author-email: Cloud TPU Team <cloud-tpu-eng@google.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/google/cloud-tpu-monitoring-debugging
+Project-URL: Bug Tracker, https://github.com/google/xpk/issues
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+<!--
+ Copyright 2023 Google LLC
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Overview
+
+xpk (Accelerated Processing Kit, pronounced x-p-k,) is a software tool to help
+Cloud developers to orchestrate training jobs on accelerators such as TPUs and
+GPUs on GKE. xpk handles the "multihost pods" of TPUs and GPUs (HGX H100) as
+first class citizens.
+
+xpk decouples provisioning capacity from running jobs. There are two structures:
+clusters (provisioned VMs) and workloads (training jobs). Clusters represent the
+physical resources you have available. Workloads represent training jobs -- at
+any time some of these will be completed, others will be running and some will
+be queued, waiting for cluster resources to become available.
+
+The ideal workflow starts by provisioning the clusters for all of the ML
+hardware you have reserved. Then, without re-provisioning, submit jobs as
+needed. By eliminating the need for re-provisioning between jobs, using Docker
+containers with pre-installed dependencies and cross-ahead of time compilation,
+these queued jobs run with minimal start times. Further, because workloads
+return the hardware back to the shared pool when they complete, developers can
+achieve better use of finite hardware resources. And automated tests can run
+overnight while resources tend to be underutilized.
+
+# Installation
+To install xpk, run the following command:
+
+```shell
+pip install xpk
+```
+
+# XPK for Large Scale (>1k VMs)
+
+Follow user instructions in [xpk-large-scale-guide.sh](xpk-large-scale-guide.sh)
+to use xpk for a GKE cluster greater than 1000 VMs. Run these steps to set up a
+GKE cluster with large scale training and high throughput support with XPK, and
+run jobs with XPK. We recommend you manually copy commands per step and verify
+the outputs of each step.
+
+# Example usages:
+
+To get started, be sure to set your GCP Project and Zone as usual via `gcloud
+config set`.
+
+Below are reference commands. A typical journey starts with a `Cluster Create`
+followed by many `Workload Create`s. To understand the state of the system you
+might want to use `Cluster List` or `Workload List` commands. Finally, you can
+cleanup with a `Cluster Delete`.
+
+## Cluster Create
+*   Cluster Create (provision on-demand capacity):
+
+    ```shell
+    python3 xpk.py cluster create \
+    --cluster xpk-test --tpu-type=v5litepod-16 \
+    --num-slices=4
+    ```
+
+
+*   Cluster Create (provision reserved capacity):
+
+    ```shell
+    python3 xpk.py cluster create \
+    --cluster xpk-test --tpu-type=v5litepod-256 \
+    --num-slices=2 \
+    --custom-tpu-nodepool-arguments="--reservation-affinity=specific --reservation=RESERVATION_ID"
+    ```
+
+*   Cluster Create can be called again with the same `--cluster name` to modify
+    the number of slices or retry failed steps.
+
+    For example, if a user creates a cluster with 4 slices:
+
+    ```shell
+    python3 xpk.py cluster create \
+    --cluster xpk-test --tpu-type=v5litepod-16 \
+    --num-slices=4
+    ```
+
+    and recreates the cluster with 8 slices. The command will rerun to create 4
+    new slices:
+
+    ```shell
+    python3 xpk.py cluster create \
+    --cluster xpk-test --tpu-type=v5litepod-16 \
+    --num-slices=8
+    ```
+
+    and recreates the cluster with 6 slices. The command will rerun to delete 2
+    slices. The command will warn the user when deleting slices.
+    Use `--force` to skip prompts.
+
+    ```shell
+    python3 xpk.py cluster create \
+    --cluster xpk-test --tpu-type=v5litepod-16 \
+    --num-slices=6
+
+    # Skip delete prompts using --force.
+
+    python3 xpk.py cluster create --force \
+    --cluster xpk-test --tpu-type=v5litepod-16 \
+    --num-slices=6
+
+    ```
+## Cluster Delete
+*   Cluster Delete (deprovision capacity):
+
+    ```shell
+    python3 xpk.py cluster delete \
+    --cluster xpk-test
+    ```
+## Cluster List
+*   Cluster List (see provisioned capacity):
+
+    ```shell
+    python3 xpk.py cluster list
+    ```
+## Cluster Describe
+*   Cluster Describe (see capacity):
+
+    ```shell
+    python3 xpk.py cluster describe \
+    --cluster xpk-test
+    ```
+
+## Cluster Cacheimage
+*   Cluster Cacheimage (enables faster start times):
+
+    ```shell
+    python3 xpk.py cluster cacheimage \
+    --cluster xpk-test --docker-image gcr.io/your_docker_image
+    ```
+
+## Workload Create
+*   Workload Create (submit training job):
+
+    ```shell
+    python3 xpk.py workload create \
+    --workload xpk-test-workload --command "echo goodbye" --cluster \
+    xpk-test --tpu-type=v5litepod-16
+    ```
+
+### Workload Priority and Preemption
+* Set the priority level of your workload with `--priority=LEVEL`
+
+  We have five priorities defined: [`very-low`, `low`, `medium`, `high`, `very-high`].
+  The default priority is `medium`.
+
+  Priority determines:
+
+  1. Order of queued jobs.
+
+      Queued jobs are ordered by
+      `very-low` < `low` < `medium` < `high` <  `very-high`
+
+  2. Preemption of lower priority workloads.
+
+      A higher priority job will `evict` lower priority jobs.
+      Evicted jobs are brought back to the queue and will re-hydrate appropriately.
+
+  #### General Example:
+  ```shell
+  python3 xpk.py workload create \
+  --workload xpk-test-medium-workload --command "echo goodbye" --cluster \
+  xpk-test --tpu-type=v5litepod-16 --priority=medium
+  ```
+
+## Workload Delete
+*   Workload Delete (delete training job):
+
+    ```shell
+    python3 xpk.py workload delete \
+    --workload xpk-test-workload --cluster xpk-test
+    ```
+
+## Workload List
+*   Workload List (see training jobs):
+
+    ```shell
+    python3 xpk.py workload list \
+    --cluster xpk-test
+    ```
+
+* Example Workload List Output:
+
+  The below example shows four jobs of different statuses:
+
+  * `user-first-job-failed`: **filter-status** is `FINISHED` and `FAILED`.
+  * `user-second-job-success`: **filter-status** is `FINISHED` and `SUCCESSFUL`.
+  * `user-third-job-running`: **filter-status** is `RUNNING`.
+  * `user-forth-job-in-queue`: **filter-status** is `QUEUED`.
+  * `user-fifth-job-in-queue-preempted`: **filter-status** is `QUEUED`.
+
+  ```
+  Jobset Name                     Created Time           Priority   TPU VMs Needed   TPU VMs Running/Ran   TPU VMs Done      Status     Status Message                                                  Status Time
+  user-first-job-failed           2023-1-1T1:00:00Z      medium     4                4                     <none>            Finished   JobSet failed                                                   2023-1-1T1:05:00Z
+  user-second-job-success         2023-1-1T1:10:00Z      medium     4                4                     4                 Finished   JobSet finished successfully                                    2023-1-1T1:14:00Z
+  user-third-job-running          2023-1-1T1:15:00Z      medium     4                4                     <none>            Admitted   Admitted by ClusterQueue cluster-queue                          2023-1-1T1:16:00Z
+  user-forth-job-in-queue         2023-1-1T1:16:05Z      medium     4                <none>                <none>            Admitted   couldn't assign flavors to pod set slice-job: insufficient unused quota for google.com/tpu in flavor 2xv4-8, 4 more need   2023-1-1T1:16:10Z
+  user-fifth-job-preempted        2023-1-1T1:10:05Z      low        4                <none>                <none>            Evicted    Preempted to accommodate a higher priority Workload             2023-1-1T1:10:00Z
+  ```
+
+* Workload List supports filtering. Observe a portion of jobs that match user criteria.
+
+  * Filter by Status: `filter-by-status`
+
+  Filter the workload list by the status of respective jobs.
+  Status can be: `EVERYTHING`,`FINISHED`, `RUNNING`, `QUEUED`, `FAILED`, `SUCCESSFUL`
+
+  * Filter by Job: `filter-by-job`
+
+  Filter the workload list by the name of a job.
+
+    ```shell
+    python3 xpk.py workload list \
+    --cluster xpk-test --filter-by-job=$USER
+    ```
+
+# How to add docker images to a xpk workload
+
+The default behavior is `xpk workload create` will layer the local directory (`--script-dir`) into
+the base docker image (`--base-docker-image`) and run the workload command.
+If you don't want this layering behavior, you can directly use `--docker-image`. Do not mix arguments from the two flows in the same command.
+
+## Recommended / Default Docker Flow: `--base-docker-image` and `--script-dir`
+This flow pulls the `--script-dir` into the `--base-docker-image` and runs the new docker image.
+
+* The below arguments are optional by default. xpk will pull the local
+  directory with a generic base docker image.
+
+  - `--base-docker-image` sets the base image that xpk will start with.
+
+  - `--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.
+
+* 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 \
+  --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 \
+  --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
+  ```
+
+## Optional Direct Docker Image Configuration: `--docker-image`
+If a user wants to directly set the docker image used and not layer in the
+current working directory, set `--docker-image` to the image to be use in the
+workload.
+
+* Running with `--docker-image`:
+  ```shell
+  python3 xpk.py 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 \
+  --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 \
+  --workload xpk-test-workload-base-image --command "bash test.sh" \
+  --tpu-type=v5litepod-16 --num-slices=1 --docker-image=gcr.io/your_docker_image
+  ```
+
+# More advanced facts:
+
+* Workload create accepts a --docker-name and --docker-image.
+By using custom images you can achieve very fast boots and hence very fast
+feedback.
+
+* Workload create accepts a --env-file flag to allow specifying the container's
+environment from a file. Usage is the same as Docker's
+[--env-file flag](https://docs.docker.com/engine/reference/commandline/run/#env)
+
+* Workload create accepts a --debug-dump-gcs flag which is a path to GCS bucket.
+Passing this flag sets the XLA_FLAGS='--xla_dump_to=/tmp/xla_dump/' and uploads
+hlo dumps to the specified GCS bucket for each worker.
+
+
+# Troubleshooting
+
+## `Invalid machine type` for CPUs.
+XPK will create a regional GKE cluster. If you see issues like
+
+```shell
+Invalid machine type e2-standard-32 in zone $ZONE_NAME
+```
+
+Please select a CPU type that exists in all zones in the region.
+
+```shell
+# Find CPU Types supported in zones.
+gcloud compute machine-types list --zones=$ZONE_LIST
+# Adjust default cpu machine type.
+python3 xpk.py cluster create --cluster-cpu-machine-type=CPU_TYPE ...
+```