Skip to content

Commit 211bbba

Browse files
authored
Merge branch 'documentation' into documentation
2 parents 1d475e9 + 699e7b8 commit 211bbba

File tree

2 files changed

+76
-1
lines changed

2 files changed

+76
-1
lines changed

doc/getting_started.ipynb

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"metadata": {},
6+
"source": [
7+
"(getting_started)=\n",
8+
"# Getting Started with SageMaker HyperPod CLI\n",
9+
"\n",
10+
"This notebook provides a quick introduction to using the SageMaker HyperPod CLI."
11+
]
12+
},
13+
{
14+
"cell_type": "markdown",
15+
"metadata": {},
16+
"source": [
17+
"## Installation\n",
18+
"\n",
19+
"You can install the SageMaker HyperPod CLI using pip:"
20+
]
21+
},
22+
{
23+
"cell_type": "code",
24+
"execution_count": null,
25+
"metadata": {},
26+
"outputs": [],
27+
"source": [
28+
"pip install sagemaker-hyperpod-cli"
29+
]
30+
},
31+
{
32+
"cell_type": "markdown",
33+
"metadata": {},
34+
"source": [
35+
"## Basic Usage\n",
36+
"\n",
37+
"Here's a simple example of how to use the SageMaker HyperPod CLI:"
38+
]
39+
},
40+
{
41+
"cell_type": "code",
42+
"execution_count": null,
43+
"metadata": {},
44+
"outputs": [],
45+
"source": [
46+
"# Import the necessary modules\n",
47+
"import sagemaker_hyperpod_cli\n",
48+
"\n",
49+
"# Example code here\n",
50+
"print(\"Hello from SageMaker HyperPod CLI!\")"
51+
]
52+
}
53+
],
54+
"metadata": {
55+
"kernelspec": {
56+
"display_name": "Python 3",
57+
"language": "python",
58+
"name": "python3"
59+
},
60+
"language_info": {
61+
"codemirror_mode": {
62+
"name": "ipython",
63+
"version": 3
64+
},
65+
"file_extension": ".py",
66+
"mimetype": "text/x-python",
67+
"name": "python",
68+
"nbconvert_exporter": "python",
69+
"pygments_lexer": "ipython3",
70+
"version": "3.9.0"
71+
}
72+
},
73+
"nbformat": 4,
74+
"nbformat_minor": 4
75+
}

doc/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ sphinx-book-theme>=1.0.0
77
linkify-it-py>=2.0.0
88
sphinx-design>=0.5.0
99
sphinx-tabs>=3.4.1
10-
sphinx-copybutton
10+
sphinx-copybutton

0 commit comments

Comments
 (0)