Merge Documentation changes to main for Launch

.gitignore

@@ -16,6 +16,7 @@ __pycache__/
 /.mypy_cache
 
 /doc/_apidoc/
+doc/_build/
 /build
 
 /sagemaker-hyperpod/build

.readthedocs.yaml

@@ -0,0 +1,20 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: doc/requirements.txt
+
+sphinx:
+  configuration: doc/conf.py
+  fail_on_warning: false
+
+formats:
+  - pdf
+  - epub

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python3 -msphinx
+SPHINXPROJ    = sagemaker
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/_static/custom.css

@@ -0,0 +1,61 @@
+/* Custom styles for SageMaker HyperPod documentation */
+
+/* Adjust logo size and alignment */
+.navbar-brand img {
+    max-height: 40px;
+    width: auto;
+    margin-right: 10px;
+    vertical-align: middle;
+}
+
+.navbar-brand .title {
+    font-weight: 800;
+    color: #111827;
+}
+
+/* Ensure logo container doesn't force wrapping */
+.navbar-brand-box {
+    width: auto;
+    flex-shrink: 0;
+}
+
+/* Header styling */
+header {
+    background-color: white;
+
+    box-shadow: 0 1px 2px rgba(0, 0, 0, 0.05);
+    position: sticky;
+    top: 0;
+    z-index: 50;
+}
+
+h1 {
+    font-size: 1.875rem;
+    font-weight: 700;
+    color: #111827;
+}
+
+h2 {
+    font-size: 1.5rem;
+    font-weight: 700;
+    color: #111827;
+}
+
+h3 {
+    font-size: 1.25rem;
+    font-weight: 500;
+    color: #111827;
+}
+
+p {
+    font-size: 1.0rem;
+    color: #4b5563;
+}
+
+html[data-theme="dark"] .navbar-brand .title {
+    color: #f8fafc !important;
+}
+
+html[data-theme="dark"] p {
+    color: #d1d5db !important;
+}

doc/_static/search_accessories.css

@@ -0,0 +1,29 @@
+.example-badge {
+    background-color: #c63340;
+    color: white;
+    padding: 0.25rem 0.5rem;
+    text-align: center;
+    border-radius: 5px;
+    font-size: 0.8rem;
+    display: inline-block;
+}
+
+.aws-doc-badge {
+    background-color: #e18b50;
+    color: white;
+    padding: 0.25rem 0.5rem;
+    text-align: center;
+    border-radius: 5px;
+    font-size: 0.8rem;
+    display: inline-block;
+}
+
+.sdk-doc-badge {
+    background-color: #4c968f;
+    color: white;
+    padding: 0.25rem 0.5rem;
+    text-align: center;
+    border-radius: 5px;
+    font-size: 0.8rem;
+    display: inline-block;
+}

doc/advanced_resources.md

@@ -0,0 +1,54 @@
+(advanced_resources)=
+
+# Advanced Resources
+
+```{toctree}
+:hidden:
+:maxdepth: 2
+
+examples
+AWS SageMaker HyperPod Docs<https://docs.aws.amazon.com/sagemaker/latest/dg/hyperpod.html>
+HyperPod Developer Guide<https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US>
+SageMaker HyperPod Workshop<https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US>
+
+```
+
+## Advanced Resources
+
+::::{grid} 1 2 2 2
+:gutter: 3
+
+:::{grid-item-card} Github
+:link: examples
+:link-type: ref
+:class-card: sd-border-secondary
+
+**Example Notebooks** - Ready-to-use implementation guides
+:::
+
+:::{grid-item-card} AWS SageMaker HyperPod Docs
+:link: https://docs.aws.amazon.com/sagemaker/latest/dg/hyperpod.html
+:link-type: url
+:class-card: sd-border-secondary
+
+**HyperPod Documentation** - Know more about HyperPod
+:::
+
+:::{grid-item-card} HyperPod Developer Guide
+:link: https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US
+:link-type: url
+:class-card: sd-border-secondary
+
+**Developer Guide** - Refer to this practical development guide
+:::
+
+:::{grid-item-card} SageMaker HyperPod Workshop
+:link: https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US
+:link-type: url
+:class-card: sd-border-secondary
+
+**Practical Guide** - Refer to the workshop for detailed follow-through steps
+:::
+
+
+::::

doc/api/api_index.rst

@@ -0,0 +1,33 @@
+#############
+SDK Reference
+#############
+
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+
+   training/hyperpod_pytorch_job
+   inference/hp_endpoint
+
+Complete reference for the SageMaker HyperPod SDK.
+
+.. container::
+
+   .. grid:: 1 1 3 3
+      :gutter: 3
+
+      .. grid-item-card:: Training SDK
+         :link: training/hyperpod_pytorch_job
+         :link-type: doc
+         :class-card: sd-border-secondary
+
+         Training SDK classes, methods and parameters.
+
+      .. grid-item-card:: Inference SDK
+         :link: inference/hp_endpoint
+         :link-type: doc
+         :class-card: sd-border-secondary
+
+         Inference SDK classes, methods and parameters.
+
+

doc/api/inference/hp_endpoint.rst

@@ -0,0 +1,45 @@
+Inference
+===========
+
+* `HPEndpointBase`_
+* `HPEndpoint`_
+* `HPJumpStartEndpoint`_
+* `HPEndpoint Configs`_
+
+
+HPEndpointBase
+-------------------
+
+.. automodule:: sagemaker.hyperpod.inference.hp_endpoint_base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+HPEndpoint
+-------------------
+
+.. automodule:: sagemaker.hyperpod.inference.hp_endpoint
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+HPJumpStartEndpoint
+---------------------
+
+.. automodule:: sagemaker.hyperpod.inference.hp_jumpstart_endpoint
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+HPEndpoint Configs
+-------------------
+
+.. automodule:: sagemaker.hyperpod.inference.config.hp_endpoint_config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: sagemaker.hyperpod.inference.config.hp_jumpstart_endpoint_config
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/api/metadata.rst

@@ -0,0 +1,7 @@
+Metadata
+------------
+
+.. automodule:: sagemaker.hyperpod.common.config.metadata
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/api/training/hyperpod_pytorch_job.rst

@@ -0,0 +1,24 @@
+Training
+===========
+
+* `HyperPodPytorchJob`_
+* `HyperPodPytorchJob Configs`_
+
+
+HyperPodPytorchJob
+-------------------
+
+.. automodule:: sagemaker.hyperpod.training.hyperpod_pytorch_job
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+HyperPodPytorchJob Configs
+---------------------------
+
+.. automodule:: sagemaker.hyperpod.training.config.hyperpod_pytorch_job_unified_config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+