Skip to content

Commit 17cfdbd

Browse files
rsareddy0329zhaoqizqwangpintaoz-awspintaozRoja Reddy Sareddy
authored
Merge Documentation changes to main for Launch (#196)
* Update documentation-with-new-changes branch with latest changes from main (#190) * Fix training test (#184) * Fix SDK training test: Add wait time before refresh * Fix training tests in canaries * Update logging information for submitting and deleting training job (#189) Co-authored-by: pintaoz <[email protected]> --------- Co-authored-by: Zhaoqi <[email protected]> Co-authored-by: pintaoz-aws <[email protected]> Co-authored-by: pintaoz <[email protected]> * Documentation Fixes (#191) Co-authored-by: Roja Reddy Sareddy <[email protected]> * update documentation with new changes branch with latest changes (#194) * Fix training test (#184) * Fix SDK training test: Add wait time before refresh * Fix training tests in canaries * Update logging information for submitting and deleting training job (#189) Co-authored-by: pintaoz <[email protected]> --------- Co-authored-by: Zhaoqi <[email protected]> Co-authored-by: pintaoz-aws <[email protected]> Co-authored-by: pintaoz <[email protected]> * Documentation Fixes (#195) * Documentation Fixes * Documentation Fixes --------- Co-authored-by: Roja Reddy Sareddy <[email protected]> * Documentation Fixes (#197) * Documentation Fixes * Documentation Fixes * Documentation Fixes * Documentation Fixes --------- Co-authored-by: Roja Reddy Sareddy <[email protected]> * Documentation Fixes (#198) * Documentation Fixes * Documentation Fixes * Documentation Fixes * Documentation Fixes * Documentation Fixes --------- Co-authored-by: Roja Reddy Sareddy <[email protected]> * Documentation fixes (#199) * Documentation Fixes * Documentation Fixes * Documentation Fixes * Documentation Fixes * Documentation Fixes * Documentation Fixes --------- Co-authored-by: Roja Reddy Sareddy <[email protected]> --------- Co-authored-by: Zhaoqi <[email protected]> Co-authored-by: pintaoz-aws <[email protected]> Co-authored-by: pintaoz <[email protected]> Co-authored-by: Roja Reddy Sareddy <[email protected]>
1 parent 28424e4 commit 17cfdbd

25 files changed

+1897
-51
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ __pycache__/
1616
/.mypy_cache
1717

1818
/doc/_apidoc/
19+
doc/_build/
1920
/build
2021

2122
/sagemaker-hyperpod/build

‎.readthedocs.yaml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
version: 2
2+
3+
build:
4+
os: ubuntu-22.04
5+
tools:
6+
python: "3.9"
7+
8+
python:
9+
install:
10+
- method: pip
11+
path: .
12+
- requirements: doc/requirements.txt
13+
14+
sphinx:
15+
configuration: doc/conf.py
16+
fail_on_warning: false
17+
18+
formats:
19+
- pdf
20+
- epub

‎doc/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = python3 -msphinx
7+
SPHINXPROJ = sagemaker
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎doc/_static/custom.css‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
/* Custom styles for SageMaker HyperPod documentation */
2+
3+
/* Adjust logo size and alignment */
4+
.navbar-brand img {
5+
max-height: 40px;
6+
width: auto;
7+
margin-right: 10px;
8+
vertical-align: middle;
9+
}
10+
11+
.navbar-brand .title {
12+
font-weight: 800;
13+
color: #111827;
14+
}
15+
16+
/* Ensure logo container doesn't force wrapping */
17+
.navbar-brand-box {
18+
width: auto;
19+
flex-shrink: 0;
20+
}
21+
22+
/* Header styling */
23+
header {
24+
background-color: white;
25+
26+
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.05);
27+
position: sticky;
28+
top: 0;
29+
z-index: 50;
30+
}
31+
32+
h1 {
33+
font-size: 1.875rem;
34+
font-weight: 700;
35+
color: #111827;
36+
}
37+
38+
h2 {
39+
font-size: 1.5rem;
40+
font-weight: 700;
41+
color: #111827;
42+
}
43+
44+
h3 {
45+
font-size: 1.25rem;
46+
font-weight: 500;
47+
color: #111827;
48+
}
49+
50+
p {
51+
font-size: 1.0rem;
52+
color: #4b5563;
53+
}
54+
55+
html[data-theme="dark"] .navbar-brand .title {
56+
color: #f8fafc !important;
57+
}
58+
59+
html[data-theme="dark"] p {
60+
color: #d1d5db !important;
61+
}

‎doc/_static/image.png‎

2.51 KB
Loading

‎doc/_static/image_dark.png‎

36.9 KB
Loading

‎doc/_static/image_light.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎doc/_static/search_accessories.css‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.example-badge {
2+
background-color: #c63340;
3+
color: white;
4+
padding: 0.25rem 0.5rem;
5+
text-align: center;
6+
border-radius: 5px;
7+
font-size: 0.8rem;
8+
display: inline-block;
9+
}
10+
11+
.aws-doc-badge {
12+
background-color: #e18b50;
13+
color: white;
14+
padding: 0.25rem 0.5rem;
15+
text-align: center;
16+
border-radius: 5px;
17+
font-size: 0.8rem;
18+
display: inline-block;
19+
}
20+
21+
.sdk-doc-badge {
22+
background-color: #4c968f;
23+
color: white;
24+
padding: 0.25rem 0.5rem;
25+
text-align: center;
26+
border-radius: 5px;
27+
font-size: 0.8rem;
28+
display: inline-block;
29+
}

‎doc/advanced_resources.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
(advanced_resources)=
2+
3+
# Advanced Resources
4+
5+
```{toctree}
6+
:hidden:
7+
:maxdepth: 2
8+
9+
examples
10+
AWS SageMaker HyperPod Docs<https://docs.aws.amazon.com/sagemaker/latest/dg/hyperpod.html>
11+
HyperPod Developer Guide<https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US>
12+
SageMaker HyperPod Workshop<https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US>
13+
14+
```
15+
16+
## Advanced Resources
17+
18+
::::{grid} 1 2 2 2
19+
:gutter: 3
20+
21+
:::{grid-item-card} Github
22+
:link: examples
23+
:link-type: ref
24+
:class-card: sd-border-secondary
25+
26+
**Example Notebooks** - Ready-to-use implementation guides
27+
:::
28+
29+
:::{grid-item-card} AWS SageMaker HyperPod Docs
30+
:link: https://docs.aws.amazon.com/sagemaker/latest/dg/hyperpod.html
31+
:link-type: url
32+
:class-card: sd-border-secondary
33+
34+
**HyperPod Documentation** - Know more about HyperPod
35+
:::
36+
37+
:::{grid-item-card} HyperPod Developer Guide
38+
:link: https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US
39+
:link-type: url
40+
:class-card: sd-border-secondary
41+
42+
**Developer Guide** - Refer to this practical development guide
43+
:::
44+
45+
:::{grid-item-card} SageMaker HyperPod Workshop
46+
:link: https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US
47+
:link-type: url
48+
:class-card: sd-border-secondary
49+
50+
**Practical Guide** - Refer to the workshop for detailed follow-through steps
51+
:::
52+
53+
54+
::::

‎doc/api/api_index.rst‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
#############
2+
SDK Reference
3+
#############
4+
5+
.. toctree::
6+
:hidden:
7+
:maxdepth: 2
8+
9+
training/hyperpod_pytorch_job
10+
inference/hp_endpoint
11+
12+
Complete reference for the SageMaker HyperPod SDK.
13+
14+
.. container::
15+
16+
.. grid:: 1 1 3 3
17+
:gutter: 3
18+
19+
.. grid-item-card:: Training SDK
20+
:link: training/hyperpod_pytorch_job
21+
:link-type: doc
22+
:class-card: sd-border-secondary
23+
24+
Training SDK classes, methods and parameters.
25+
26+
.. grid-item-card:: Inference SDK
27+
:link: inference/hp_endpoint
28+
:link-type: doc
29+
:class-card: sd-border-secondary
30+
31+
Inference SDK classes, methods and parameters.
32+
33+

0 commit comments

Comments
 (0)