Skip to content

Commit 6e72f27

Browse files
rsareddy0329Roja Reddy Sareddy
rsareddy0329
and
Roja Reddy Sareddy
authored
Documentation Fixes (#187)
* Documentation Fixes * Documentation Fixes * Documentation Fixes * Documentation Fixes * Documentation Fixes * Documentation Fixes * Documentation Fixes --------- Co-authored-by: Roja Reddy Sareddy <[email protected]>
1 parent d6de9eb commit 6e72f27

File tree

10 files changed

+122
-63
lines changed

10 files changed

+122
-63
lines changed

‎doc/api/api_index.rst‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,31 @@ SDK Reference
33
#############
44

55
.. toctree::
6-
:maxdepth: 1
6+
:hidden:
7+
:maxdepth: 2
78

8-
training_api
9-
inference_api
9+
training/hyperpod_pytorch_job
10+
inference/hp_endpoint
1011

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.
1132

1233

‎doc/api/inference/hp_endpoint.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
Inference
2+
===========
3+
4+
* `HPEndpointBase`_
5+
* `HPEndpoint`_
6+
* `HPJumpStartEndpoint`_
7+
* `HPEndpoint Configs`_
8+
9+
10+
HPEndpointBase
11+
-------------------
12+
13+
.. automodule:: sagemaker.hyperpod.inference.hp_endpoint_base
14+
:members:
15+
:undoc-members:
16+
:show-inheritance:
17+
18+
HPEndpoint
19+
-------------------
20+
21+
.. automodule:: sagemaker.hyperpod.inference.hp_endpoint
22+
:members:
23+
:undoc-members:
24+
:show-inheritance:
25+
26+
HPJumpStartEndpoint
27+
---------------------
28+
29+
.. automodule:: sagemaker.hyperpod.inference.hp_jumpstart_endpoint
30+
:members:
31+
:undoc-members:
32+
:show-inheritance:
33+
34+
HPEndpoint Configs
35+
-------------------
36+
37+
.. automodule:: sagemaker.hyperpod.inference.config.hp_endpoint_config
38+
:members:
39+
:undoc-members:
40+
:show-inheritance:
41+
42+
.. automodule:: sagemaker.hyperpod.inference.config.hp_jumpstart_endpoint_config
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:

‎doc/api/inference_api.rst‎

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎doc/api/metadata.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Metadata
2+
------------
3+
4+
.. automodule:: sagemaker.hyperpod.common.config.metadata
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/api/training_api.rst‎ renamed to ‎doc/api/training/hyperpod_pytorch_job.rst‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
11
Training
2-
------------
2+
===========
3+
4+
* `HyperPodPytorchJob`_
5+
* `HyperPodPytorchJob Configs`_
6+
7+
8+
HyperPodPytorchJob
9+
-------------------
310

411
.. automodule:: sagemaker.hyperpod.training.hyperpod_pytorch_job
512
:members:
613
:undoc-members:
714
:show-inheritance:
815

16+
917
HyperPodPytorchJob Configs
10-
------------
18+
---------------------------
1119

1220
.. automodule:: sagemaker.hyperpod.training.config.hyperpod_pytorch_job_unified_config
1321
:members:
1422
:undoc-members:
1523
:show-inheritance:
1624

17-

‎doc/cli_inference.md‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,28 @@
22

33
# Inference
44

5+
Complete reference for SageMaker HyperPod inference parameters and configuration options.
6+
7+
* [Create JumpStart Endpoint](#hyp-create-hyp-jumpstart-endpoint)
8+
* [Create Custom Endpoint](#hyp-create-hyp-custom-endpoint)
9+
10+
* [List JumpStart Endpoints](#hyp-list-hyp-jumpstart-endpoint)
11+
* [List Custom Endpoints](#hyp-list-hyp-custom-endpoint)
12+
* [Describe JumpStart Endpoint](#hyp-describe-hyp-jumpstart-endpoint)
13+
* [Describe Custom Endpoint](#hyp-describe-hyp-custom-endpoint)
14+
* [Invoke JumpStart Endpoint](#hyp-invoke-hyp-jumpstart-endpoint)
15+
* [Invoke Custom Endpoint](#hyp-invoke-hyp-custom-endpoint)
16+
* [Delete JumpStart Endpoint](#hyp-delete-hyp-jumpstart-endpoint)
17+
* [Delete Custom Endpoint](#hyp-delete-hyp-custom-endpoint)
18+
19+
* [List JumpStart Pods](#hyp-list-pods-hyp-jumpstart-endpoint)
20+
* [List Custom Pods](#hyp-list-pods-hyp-custom-endpoint)
21+
* [Get JumpStart Logs](#hyp-get-logs-hyp-jumpstart-endpoint)
22+
* [Get Custom Logs](#hyp-get-logs-hyp-custom-endpoint)
23+
* [Get JumpStart Operator Logs](#hyp-get-operator-logs-hyp-jumpstart-endpoint)
24+
* [Get Custom Operator Logs](#hyp-get-operator-logs-hyp-custom-endpoint)
25+
526

6-
Complete reference for SageMaker HyperPod PyTorch training job parameters and configuration options.
727

828
## hyp create hyp-jumpstart-endpoint
929

‎doc/cli_training.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,16 @@
33

44
# Training
55

6-
76
Complete reference for SageMaker HyperPod PyTorch training job parameters and configuration options.
87

8+
* [Create PyTorch Job](#hyp-create-hyp-pytorch-job)
9+
* [List Jobs](#hyp-list-hyp-pytorch-job)
10+
* [Describe Job](#hyp-describe-hyp-pytorch-job)
11+
* [Delete Job](#hyp-delete-hyp-pytorch-job)
12+
* [List Pods](#hyp-list-pods-hyp-pytorch-job)
13+
* [Get Logs](#hyp-get-logs-hyp-pytorch-job)
14+
15+
916
## hyp create hyp-pytorch-job
1017

1118
Create distributed PyTorch training jobs on SageMaker HyperPod clusters.

‎doc/conf.py‎

Lines changed: 3 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -22,42 +22,10 @@
2222
from typing import Dict, List, Any, Optional
2323

2424

25-
def run_apidoc(app):
26-
"""Generate doc stubs using sphinx-apidoc."""
27-
module_dir = os.path.join(app.srcdir, "../src/")
28-
output_dir = os.path.join(app.srcdir, "_apidoc")
29-
excludes = []
30-
31-
# Ensure that any stale apidoc files are cleaned up first.
32-
if os.path.exists(output_dir):
33-
shutil.rmtree(output_dir)
34-
35-
cmd = [
36-
"--separate",
37-
"--module-first",
38-
"--doc-project=SDK API Reference",
39-
"-o",
40-
output_dir,
41-
module_dir,
42-
]
43-
cmd.extend(excludes)
44-
45-
try:
46-
from sphinx.ext import apidoc # Sphinx >= 1.7
47-
48-
apidoc.main(cmd)
49-
except ImportError:
50-
from sphinx import apidoc # Sphinx < 1.7
51-
52-
cmd.insert(0, apidoc.__file__)
53-
apidoc.main(cmd)
54-
5525

5626
def setup(app):
5727
"""Register our sphinx hooks."""
5828

59-
#app.connect("builder-inited", run_apidoc)
60-
6129

6230
# Get version from setup.py
6331
def get_version():
@@ -105,12 +73,6 @@ def get_version():
10573
"sphinx.ext.autosectionlabel",
10674
]
10775

108-
'''
109-
# Mock modules that might not be available during documentation build
110-
autodoc_mock_imports = [
111-
'sagemaker.hyperpod.training.config.hyperpod_pytorch_job_config',
112-
'hyperpod_pytorch_job_template.registry',
113-
]'''
11476
autodoc_mock_imports = ["pyspark", "feature_store_pyspark", "py4j"]
11577

11678
source_suffix = {
@@ -150,7 +112,9 @@ def get_version():
150112

151113
htmlhelp_basename = "{}doc".format(project)
152114
html_static_path = ["_static"]
153-
html_css_files = ["custom.css"]
115+
html_css_files = ["custom.css",
116+
"search_accessories.css",
117+
]
154118
napoleon_use_rtype = False
155119

156120
# nbsphinx configuration

‎doc/index.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,20 +109,23 @@ Version Info - you’re viewing latest documentation for SageMaker Hyperpod CLI
109109

110110
:::{grid-item-card} AWS SageMaker HyperPod Docs
111111
:link: https://docs.aws.amazon.com/sagemaker/latest/dg/hyperpod.html
112+
:link-type: url
112113
:class-card: sd-border-secondary
113114

114115
**HyperPod Documentation** - Know more about HyperPod
115116
:::
116117

117118
:::{grid-item-card} HyperPod Developer Guide
118119
:link: https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US
120+
:link-type: url
119121
:class-card: sd-border-secondary
120122

121123
**Developer Guide** - Refer to this practical development guide
122124
:::
123125

124126
:::{grid-item-card} SageMaker HyperPod Workshop
125127
:link: https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US
128+
:link-type: url
126129
:class-card: sd-border-secondary
127130

128131
**Practical Guide** - Refer to the workshop for detailed follow-through steps

‎doc/installation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
(installation)=
2-
# Get Started
2+
# Installation
33
This guide provides installation instructions for the SageMaker HyperPod CLI and SDK.
44

55
## System Requirements

0 commit comments

Comments
 (0)