Skip to content

Commit e780e29

Browse files
authored
Updating README to remove old hyperpod commands (#117)
1 parent 8f0d9ef commit e780e29

File tree

1 file changed

+3
-19
lines changed

1 file changed

+3
-19
lines changed

README.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ The Amazon SageMaker HyperPod command-line interface (HyperPod CLI) is a tool th
55

66
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*.
77

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+
810
## Table of Contents
911
- [Overview](#overview)
1012
- [Prerequisites](#prerequisites)
@@ -72,27 +74,9 @@ SageMaker HyperPod CLI currently supports start training job with:
7274
1. Verify if the installation succeeded by running the following command.
7375
7476
```
75-
hyperpod --help
77+
hyp --help
7678
```
7779
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.
88-
```
89-
hyperpod connect-cluster --cluster-name <cluster-name>
90-
```
91-
- 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.
92-
```
93-
hyperpod start-job --config-file ./examples/basic-job-example-config.yaml
94-
```
95-
9680
## Usage
9781
9882
The HyperPod CLI provides the following commands:

0 commit comments

Comments
 (0)