Skip to content

Commit b359c08

Browse files
rsareddy0329Roja Reddy Sareddy
andauthored
Documentation Fixes (#181)
* Documentation Fixes * Documentation Fixes * Documentation Fixes * Documentation Fixes * Documentation Fixes --------- Co-authored-by: Roja Reddy Sareddy <[email protected]>
1 parent 32cd49f commit b359c08

File tree

3 files changed

+3
-26
lines changed

3 files changed

+3
-26
lines changed

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ def run_apidoc(app):
3535
cmd = [
3636
"--separate",
3737
"--module-first",
38-
"--doc-project=API Reference",
38+
"--doc-project=SDK API Reference",
3939
"-o",
4040
output_dir,
4141
module_dir,

doc/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Training <training>
2121
Inference <inference>
2222
CLI Reference <cli_reference>
2323
Example Notebooks <examples>
24-
API reference <_apidoc/modules>
24+
SDK reference <_apidoc/modules>
2525
```
2626

2727

@@ -35,7 +35,7 @@ Version Info - you’re viewing latest documentation for SageMaker Hyperpod CLI
3535

3636
### Why Choose HyperPod CLI & SDK?
3737

38-
Transform your AI/ML development process with Amazon SageMaker HyperPod CLI and SDK. These tools handle infrastructure management complexities, allowing you to focus on model development and innovation. Weather it's scaling your PyTorch training jobs across thousands of GPUs, deploying production-grade inference endpoints or managing multiple clusters efficiently; the intuitive command-line interface and programmatic control enable you to:
38+
Transform your AI/ML development process with Amazon SageMaker HyperPod CLI and SDK. These tools handle infrastructure management complexities, allowing you to focus on model development and innovation. Whether it's scaling your PyTorch training jobs across thousands of GPUs, deploying production-grade inference endpoints or managing multiple clusters efficiently; the intuitive command-line interface and programmatic control enable you to:
3939
- Accelerate development cycles and reduce operational overhead
4040
- Automate ML workflows while maintaining operational visibility
4141
- Optimize computing resources across your AI/ML projects

doc/installation.md

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -60,26 +60,3 @@ To verify that the installation was successful, run:
6060
# Verify CLI installation
6161
hyp --help
6262
```
63-
64-
### Install from GitHub
65-
66-
For the latest development version or to contribute to the project, you can install directly from the GitHub repository:
67-
68-
**Clone the SageMaker HyperPod CLI package from GitHub:**
69-
```bash
70-
git clone https://github.com/aws/sagemaker-hyperpod-cli.git
71-
```
72-
73-
**Install the SageMaker HyperPod CLI:**
74-
```bash
75-
cd sagemaker-hyperpod-cli && pip install .
76-
```
77-
78-
**Test if the SageMaker HyperPod CLI is successfully installed by running the following command:**
79-
```bash
80-
hyp --help
81-
```
82-
83-
```{note}
84-
The GitHub installation provides access to the latest features and bug fixes that may not yet be available in the PyPI release. However, it may be less stable than the official PyPI release.
85-
```

0 commit comments

Comments
 (0)