You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-19Lines changed: 3 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,8 @@ The Amazon SageMaker HyperPod command-line interface (HyperPod CLI) is a tool th
5
5
6
6
This documentation serves as a reference for the available HyperPod CLI commands. For a comprehensive user guide, see [Orchestrating SageMaker HyperPod clusters with Amazon EKS](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-eks.html) in the *Amazon SageMaker Developer Guide*.
7
7
8
+
Note: Old `hyperpod`CLI V2 has been moved to `release_v2` branch. Please refer [release_v2 branch](https://github.com/aws/sagemaker-hyperpod-cli/tree/release_v2) for usage.
9
+
8
10
## Table of Contents
9
11
-[Overview](#overview)
10
12
-[Prerequisites](#prerequisites)
@@ -72,27 +74,9 @@ SageMaker HyperPod CLI currently supports start training job with:
72
74
1. Verify if the installation succeeded by running the following command.
73
75
74
76
```
75
-
hyperpod --help
77
+
hyp --help
76
78
```
77
79
78
-
1. If you have a running HyperPod cluster, you can try to run a training job using the sample configuration file provided at ```/examples/basic-job-example-config.yaml```.
79
-
- Get your HyperPod clusters to show their capacities.
80
-
```
81
-
hyperpod get-clusters
82
-
```
83
-
- Get your HyperPod clusters to show their capacities and quota allocation info for a team.
84
-
```
85
-
hyperpod get-clusters -n hyperpod-ns-<team-name>
86
-
```
87
-
- Connect to one HyperPod cluster and specify a namespace you have access to.
- Start a job in your cluster. Change the `instance_type` in the yaml file to be same as the one in your HyperPod cluster. Also change the `namespace` you want to submit a job to, the example uses kubeflow namespace. You need to have installed PyTorch in your cluster.
0 commit comments