Merge latest changes from main to 'Documentation' branch

.github/pull_request_template.md

@@ -1,32 +1,30 @@
-# PR Approval Steps
-
-## For Requester
-
-1. Description
-    - [ ] Check the PR title and description for clarity. It should describe the changes made and the reason behind them.
-    - [ ] Ensure that the PR follows the contribution guidelines, if applicable.
-2. Security requirements
-    - [ ] Ensure that a Pull Request (PR) does not expose passwords and other sensitive information by using git-secrets and upload relevant evidence: https://github.com/awslabs/git-secrets
-    - [ ] Ensure commit has GitHub Commit Signature
-3. Manual review
-    1. Click on the Files changed tab to see the code changes. Review the changes thoroughly:
-        - [ ] Code Quality: Check for coding standards, naming conventions, and readability.
-        - [ ] Functionality: Ensure that the changes meet the requirements and that all necessary code paths are tested.
-        - [ ] Security: Check for any security issues or vulnerabilities.
-        - [ ] Documentation: Confirm that any necessary documentation (code comments, README updates, etc.) has been updated.
-4. Check for Merge Conflicts:
-    - [ ] Verify if there are any merge conflicts with the base branch. GitHub will usually highlight this. If there are conflicts, you should resolve them.
-
-## For Reviewer
-
-1. Go through `For Requester` section to double check each item.
-2. Request Changes or Approve the PR:
-    1. If the PR is ready to be merged, click Review changes and select Approve.
-    2. If changes are required, select Request changes and provide feedback. Be constructive and clear in your feedback.
-3. Merging the PR
-    1. Check the Merge Method:
-        1. Decide on the appropriate merge method based on your repository's guidelines (e.g., Squash and merge, Rebase and merge, or Merge).
-    2. Merge the PR:
-        1. Click the Merge pull request button.
-        2. Confirm the merge by clicking Confirm merge.
+## What's changing and why?
+<!-- Describe what you're changing and the motivation behind it -->
 
+
+## Before/After UX
+<!-- Show the user experience before and after your changes -->
+**Before:**
+
+
+**After:**
+
+
+## How was this change tested?
+<!-- Describe your testing approach -->
+
+
+## Are unit tests added?
+
+
+## Are integration tests added?
+
+
+## Reviewer Guidelines
+
+‼️ **Merge Requirements**: PRs with failing integration tests cannot be merged without justification. 
+
+One of the following must be true:
+- [ ] All automated PR checks pass
+- [ ] Failed tests include local run results/screenshots proving they work
+- [ ] Changes are documentation-only

.github/workflows/codebuild-ci.yml

@@ -2,8 +2,7 @@ name: PR Checks
 on:
   pull_request_target:
       branches:
-          - "master*"
-          - "main*"
+          - "*"
 
 concurrency:
     group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.head_ref }}

.github/workflows/security-monitoring.yml

@@ -73,7 +73,7 @@ jobs:
         uses: aws-actions/configure-aws-credentials@12e3392609eaaceb7ae6191b3f54bbcb85b5002b
         with:
           role-to-assume: ${{ secrets.MONITORING_ROLE_ARN }}
-          aws-region: us-west-2
+          aws-region: us-east-2
       - name: Put Dependabot Alert Metric Data
         run: |
           if [ "${{ needs.check-dependabot-alerts.outputs.dependabot_alert_status }}" == "1" ]; then

.gitignore

@@ -16,14 +16,23 @@ __pycache__/
 /.mypy_cache
 
 /doc/_apidoc/
+doc/_build/
 /build
 
 /sagemaker-hyperpod/build
 /sagemaker-hyperpod/.coverage
 /sagemaker-hyperpod/.coverage.*
 
+/hyperpod-cluster-stack-template/build
+/hyperpod-pytorch-job-template/build
+/hyperpod-custom-inference-template/build
+/hyperpod-jumpstart-inference-template/build
+
 # Ignore all contents of result and results directories
 /result/
 /results/
 
-.idea/
+.idea/
+
+.venv*
+venv

.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

CHANGELOG.md

@@ -1,23 +1,109 @@
 # Changelog
 
-## v2.0.0 (2024-12-04)
+## v.3.5.0 (2025-12-03)
 
 ### Features
+  * Elastic training support for HyperPodTrainingOperator that is released in Reinvent 2025 keynote 3. This is a method that dynamically scales distributed machine learning operations.
 
-- feature: The HyperPod CLI now support ([Hyperpod recipes](https://github.com/aws/sagemaker-hyperpod-recipes.git)). The HyperPod recipes enable customers to get started training and fine-tuning popular publicly-available foundation models like Llama 3.1 405B in minutes. Learn more ([here](https://github.com/aws/sagemaker-hyperpod-recipes.git)).
 
-## v1.0.0 (2024-09-09)
+## v.3.4.0 (2025-11-20)
 
 ### Features
 
-- feature: Add support for SageMaker HyperPod CLI
+  * HyperPod Dev Spaces template for data scientists to create, manage, and access interactive ML development environments with configurable resource allocation and namespace isolation
+  * Support for KVCaching, intelligent routing, tiered storage, MIG
+  * Support for fractional gpu
+  * Support KVCache and Intelligent Routing support in template version 1.1
+  * User can modify jinja template to add parameters supported by CRD through init experience, for further CLI customization
+  * MIG support for model deployment on SageMaker Hyperpod Inference
+
+
+## v.3.3.1 (2025-10-30)
+
+### Features
+
+  * Describe cluster command
+    * User can use hyp describe cluster to learn more info about hp clusters
+  * Jinja template handling logic for inference and training
+    * User can modify jinja template to add parameters supported by CRD through init experience of inference and training, for further CLI customization
+  * Cluster creation template versioning
+    * User can choose cloudformation template version through cluster creation expeirence
+  * KVCache and intelligent routing for HyperPod Inference
+    * InferenceEndpointConfig CRD supported is updated to v1
+    * KVCache and Intelligent Routing support is added in template version 1.1
+
+
+## v.3.3.0 (2025-09-23)
+
+### Features
+
+  * Init Experience
+    * Init, Validate, and Create JumpStart endpoint, Custom endpoint, and PyTorch Training Job with local configuration
+  * Cluster management 
+    * Bug fixes for cluster creation
+
+
+## v.3.2.2 (2025-09-10)
+
+### Features
+
+  * Fix for production canary failures caused by bad training job template.
+  * New version for Health Monitoring Agent (1.0.790.0_1.0.266.0) with minor improvements and bug fixes.
+
+## v3.2.1 (2025-08-27)
+
+### Features
+
+ * Cluster management 
+   * Bug Fixes with cluster creation
+   * Enable cluster template to be installed with hyperpod CLI .
+
+## v3.2.0 (2025-08-25)
+
+### Features
+
+ * Cluster management 
+   * Creation of cluster stack 
+   * Describing and listing a cluster stack 
+   * Updating a cluster 
+ * Init Experience 
+   * Init, Validate, Create with local configurations
+
+
+## v3.1.0 (2025-08-13)
+
+### Features
+ * Task Governance feature for training jobs.
+
 
+## v3.0.2 (2025-07-31)
 
-## v1.0.0] ([2025]-[07]-[10])
+### Features
+
+ * Update volume flag to support hostPath and PVC
+ * Add an option to disable the deployment of KubeFlow TrainingOperator
+ * Enable telemetry for CLI
+
+## v3.0.0 (2025-07-10)
 
 ### Features
 
  * Training Job - Create, List , Get 
  * Inference Jumpstart - Create , List, Get, Invoke
  * Inference Custom - Create , List, Get, Invoke
- * Observability changes
+ * Observability changes
+
+## v2.0.0 (2024-12-04)
+
+### Features
+
+- feature: The HyperPod CLI now support ([Hyperpod recipes](https://github.com/aws/sagemaker-hyperpod-recipes.git)). The HyperPod recipes enable customers to get started training and fine-tuning popular publicly-available foundation models like Llama 3.1 405B in minutes. Learn more ([here](https://github.com/aws/sagemaker-hyperpod-recipes.git)).
+
+## v1.0.0 (2024-09-09)
+
+### Features
+
+- feature: Add support for SageMaker HyperPod CLI
+
+
+

NOTICE

@@ -1 +1,3 @@
-Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+This software contains source code provided by NVIDIA Corporation.