Merge Documentation changes to main for Launch - #196

Merged
rsareddy0329 merged 7 commits into
mainfrom
documentation-with-new-changes
Aug 6, 2025
Merged

Merge Documentation changes to main for Launch#196
rsareddy0329 merged 7 commits into
mainfrom
documentation-with-new-changes

Conversation

@rsareddy0329

Copy link
Copy Markdown
Collaborator

PR to merge all the documentation change to main branch for public launch

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.

rsareddy0329and others added 4 commits August 5, 2025 16:00
… 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 <pintaoz@amazon.com>
---------
Co-authored-by: Zhaoqi <zhaoqiwang.baruch@gmail.com>
Co-authored-by: pintaoz-aws <167920275+pintaoz-aws@users.noreply.github.com>
Co-authored-by: pintaoz <pintaoz@amazon.com>
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
* 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 <pintaoz@amazon.com>
---------
Co-authored-by: Zhaoqi <zhaoqiwang.baruch@gmail.com>
Co-authored-by: pintaoz-aws <167920275+pintaoz-aws@users.noreply.github.com>
Co-authored-by: pintaoz <pintaoz@amazon.com>
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
@rsareddy0329
rsareddy0329 requested a review from a team as a code ownerAugust 6, 2025 00:04
Comment thread.gitignore
/.mypy_cache

/doc/_apidoc/
doc/_build/

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this needs to be /doc/_build/ here?

@rsareddy0329rsareddy0329Aug 6, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is mainly to make sure _build is ignored in git Version control system

Comment threaddoc/installation.md
source {venv-name}/bin/activate
```
```{note}
Remember to activate your virtual environment (source {venv-name}/bin/activate) each time you want to use the HyperPod CLI and SDK if you chose the virtual environment installation method.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add code quote around source {venv-name}/bin/activate

Comment threaddoc/training.md
--image pytorch/pytorch:latest \
```
````
````{tab-item} SDK

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is SDK code keeping parity with CLI here?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be a fast-follow item

Comment threaddoc/inference.md
```
````

````{tab-item} SDK

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like SDK code here is still using some optional variables

Comment threaddoc/inference.md
````

````{tab-item} SDK
```python

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to update SDK code here too

Comment threaddoc/inference.md
# Custom endpoint
hyp list-pods hyp-custom-endpoint
```
````

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing SDK code here

Comment threaddoc/inference.md
# Custom endpoint
hyp get-logs hyp-custom-endpoint --pod-name <pod-name>
```
````

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing SDK code here

Comment threaddoc/cli_training.md

List all HyperPod PyTorch jobs in a namespace.

#### Syntax

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like Syntax is even bigger then hyp list hyp-pytorch-job, not sure why the rendering is like that

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup, mainly CSS changes required.
would be a fast follow as well.

Comment threaddoc/index.md
:::

:::{grid-item-card} HyperPod Developer Guide
:link: https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link seems to be the same as the workshop. Maybe needs an update?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, checking with Shweta on this.

* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
Comment threaddoc/inference.md Outdated
Comment on lines +134 to +143
When creating an inference endpoint, you'll need to specify:

- **endpoint-name**: Unique identifier for your endpoint
- **instance-type**: The EC2 instance type to use
- **model-id** (JumpStart): ID of the pre-trained JumpStart model
- **image-uri** (Custom): Docker image containing your inference code
- **model-name** (Custom): Name of model to create on SageMaker
- **model-source-type** (Custom): Source type: fsx or s3
- **model-volume-mount-name** (Custom): Name of the model volume mount
- **container-port** (Custom): Port on which the model server listens

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we separate this into 2

  1. Parameters required for Jumpstart
  2. Parameters required for Custom

Comment threaddoc/installation.md Outdated
Comment on lines +15 to +16
### Supported ML Frameworks
- PyTorch (version ≥ 1.10)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Supported ML Frameworks for Training maybe

Comment on lines -30 to -39
def test_set_cluster_context(self, cluster_name):
"""Test setting cluster context."""
result = execute_command([
"hyp", "set-cluster-context",
"--cluster-name", cluster_name
])
assert result.returncode == 0
context_line = result.stdout.strip().splitlines()[-1]
assert any(text in context_line for text in ["Updated context", "Added new context"])

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this change needed ?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this change is from other commits. Can you rebase to main to clean it up?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I merged in the latest changes from main and this change is shown up as diff. Change is from this PR: https://github.com/aws/sagemaker-hyperpod-cli/pull/184/files

* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
@rsareddy0329
rsareddy0329 merged commit 17cfdbd into mainAug 6, 2025
4 of 5 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@rsareddy0329@nargokul@pintaoz-aws@mollyheamazon
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Merge Documentation changes to main for Launch - #196

Merged
rsareddy0329 merged 7 commits into
mainfrom
documentation-with-new-changes
Aug 6, 2025
Merged

Merge Documentation changes to main for Launch#196
rsareddy0329 merged 7 commits into
mainfrom
documentation-with-new-changes

Conversation

@rsareddy0329

Copy link
Copy Markdown
Collaborator

PR to merge all the documentation change to main branch for public launch

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.

rsareddy0329and others added 4 commits August 5, 2025 16:00
… 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 <pintaoz@amazon.com>
---------
Co-authored-by: Zhaoqi <zhaoqiwang.baruch@gmail.com>
Co-authored-by: pintaoz-aws <167920275+pintaoz-aws@users.noreply.github.com>
Co-authored-by: pintaoz <pintaoz@amazon.com>
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
* 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 <pintaoz@amazon.com>
---------
Co-authored-by: Zhaoqi <zhaoqiwang.baruch@gmail.com>
Co-authored-by: pintaoz-aws <167920275+pintaoz-aws@users.noreply.github.com>
Co-authored-by: pintaoz <pintaoz@amazon.com>
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
@rsareddy0329
rsareddy0329 requested a review from a team as a code ownerAugust 6, 2025 00:04
Comment thread.gitignore
/.mypy_cache

/doc/_apidoc/
doc/_build/

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this needs to be /doc/_build/ here?

@rsareddy0329rsareddy0329Aug 6, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is mainly to make sure _build is ignored in git Version control system

Comment threaddoc/installation.md
source {venv-name}/bin/activate
```
```{note}
Remember to activate your virtual environment (source {venv-name}/bin/activate) each time you want to use the HyperPod CLI and SDK if you chose the virtual environment installation method.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add code quote around source {venv-name}/bin/activate

Comment threaddoc/training.md
--image pytorch/pytorch:latest \
```
````
````{tab-item} SDK

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is SDK code keeping parity with CLI here?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be a fast-follow item

Comment threaddoc/inference.md
```
````

````{tab-item} SDK

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like SDK code here is still using some optional variables

Comment threaddoc/inference.md
````

````{tab-item} SDK
```python

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to update SDK code here too

Comment threaddoc/inference.md
# Custom endpoint
hyp list-pods hyp-custom-endpoint
```
````

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing SDK code here

Comment threaddoc/inference.md
# Custom endpoint
hyp get-logs hyp-custom-endpoint --pod-name <pod-name>
```
````

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing SDK code here

Comment threaddoc/cli_training.md

List all HyperPod PyTorch jobs in a namespace.

#### Syntax

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like Syntax is even bigger then hyp list hyp-pytorch-job, not sure why the rendering is like that

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup, mainly CSS changes required.
would be a fast follow as well.

Comment threaddoc/index.md
:::

:::{grid-item-card} HyperPod Developer Guide
:link: https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link seems to be the same as the workshop. Maybe needs an update?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, checking with Shweta on this.

* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
Comment threaddoc/inference.md Outdated
Comment on lines +134 to +143
When creating an inference endpoint, you'll need to specify:

- **endpoint-name**: Unique identifier for your endpoint
- **instance-type**: The EC2 instance type to use
- **model-id** (JumpStart): ID of the pre-trained JumpStart model
- **image-uri** (Custom): Docker image containing your inference code
- **model-name** (Custom): Name of model to create on SageMaker
- **model-source-type** (Custom): Source type: fsx or s3
- **model-volume-mount-name** (Custom): Name of the model volume mount
- **container-port** (Custom): Port on which the model server listens

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we separate this into 2

  1. Parameters required for Jumpstart
  2. Parameters required for Custom

Comment threaddoc/installation.md Outdated
Comment on lines +15 to +16
### Supported ML Frameworks
- PyTorch (version ≥ 1.10)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Supported ML Frameworks for Training maybe

Comment on lines -30 to -39
def test_set_cluster_context(self, cluster_name):
"""Test setting cluster context."""
result = execute_command([
"hyp", "set-cluster-context",
"--cluster-name", cluster_name
])
assert result.returncode == 0
context_line = result.stdout.strip().splitlines()[-1]
assert any(text in context_line for text in ["Updated context", "Added new context"])

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this change needed ?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this change is from other commits. Can you rebase to main to clean it up?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I merged in the latest changes from main and this change is shown up as diff. Change is from this PR: https://github.com/aws/sagemaker-hyperpod-cli/pull/184/files

* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
@rsareddy0329
rsareddy0329 merged commit 17cfdbd into mainAug 6, 2025
4 of 5 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@rsareddy0329@nargokul@pintaoz-aws@mollyheamazon
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Merge Documentation changes to main for Launch - #196

Merged
rsareddy0329 merged 7 commits into
mainfrom
documentation-with-new-changes
Aug 6, 2025
Merged

Merge Documentation changes to main for Launch#196
rsareddy0329 merged 7 commits into
mainfrom
documentation-with-new-changes

Conversation

@rsareddy0329

Copy link
Copy Markdown
Collaborator

PR to merge all the documentation change to main branch for public launch

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.

rsareddy0329and others added 4 commits August 5, 2025 16:00
… 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 <pintaoz@amazon.com>
---------
Co-authored-by: Zhaoqi <zhaoqiwang.baruch@gmail.com>
Co-authored-by: pintaoz-aws <167920275+pintaoz-aws@users.noreply.github.com>
Co-authored-by: pintaoz <pintaoz@amazon.com>
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
* 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 <pintaoz@amazon.com>
---------
Co-authored-by: Zhaoqi <zhaoqiwang.baruch@gmail.com>
Co-authored-by: pintaoz-aws <167920275+pintaoz-aws@users.noreply.github.com>
Co-authored-by: pintaoz <pintaoz@amazon.com>
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
@rsareddy0329
rsareddy0329 requested a review from a team as a code ownerAugust 6, 2025 00:04
Comment thread.gitignore
/.mypy_cache

/doc/_apidoc/
doc/_build/

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this needs to be /doc/_build/ here?

@rsareddy0329rsareddy0329Aug 6, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is mainly to make sure _build is ignored in git Version control system

Comment threaddoc/installation.md
source {venv-name}/bin/activate
```
```{note}
Remember to activate your virtual environment (source {venv-name}/bin/activate) each time you want to use the HyperPod CLI and SDK if you chose the virtual environment installation method.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add code quote around source {venv-name}/bin/activate

Comment threaddoc/training.md
--image pytorch/pytorch:latest \
```
````
````{tab-item} SDK

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is SDK code keeping parity with CLI here?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be a fast-follow item

Comment threaddoc/inference.md
```
````

````{tab-item} SDK

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like SDK code here is still using some optional variables

Comment threaddoc/inference.md
````

````{tab-item} SDK
```python

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to update SDK code here too

Comment threaddoc/inference.md
# Custom endpoint
hyp list-pods hyp-custom-endpoint
```
````

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing SDK code here

Comment threaddoc/inference.md
# Custom endpoint
hyp get-logs hyp-custom-endpoint --pod-name <pod-name>
```
````

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing SDK code here

Comment threaddoc/cli_training.md

List all HyperPod PyTorch jobs in a namespace.

#### Syntax

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like Syntax is even bigger then hyp list hyp-pytorch-job, not sure why the rendering is like that

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup, mainly CSS changes required.
would be a fast follow as well.

Comment threaddoc/index.md
:::

:::{grid-item-card} HyperPod Developer Guide
:link: https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link seems to be the same as the workshop. Maybe needs an update?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, checking with Shweta on this.

* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
Comment threaddoc/inference.md Outdated
Comment on lines +134 to +143
When creating an inference endpoint, you'll need to specify:

- **endpoint-name**: Unique identifier for your endpoint
- **instance-type**: The EC2 instance type to use
- **model-id** (JumpStart): ID of the pre-trained JumpStart model
- **image-uri** (Custom): Docker image containing your inference code
- **model-name** (Custom): Name of model to create on SageMaker
- **model-source-type** (Custom): Source type: fsx or s3
- **model-volume-mount-name** (Custom): Name of the model volume mount
- **container-port** (Custom): Port on which the model server listens

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we separate this into 2

  1. Parameters required for Jumpstart
  2. Parameters required for Custom

Comment threaddoc/installation.md Outdated
Comment on lines +15 to +16
### Supported ML Frameworks
- PyTorch (version ≥ 1.10)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Supported ML Frameworks for Training maybe

Comment on lines -30 to -39
def test_set_cluster_context(self, cluster_name):
"""Test setting cluster context."""
result = execute_command([
"hyp", "set-cluster-context",
"--cluster-name", cluster_name
])
assert result.returncode == 0
context_line = result.stdout.strip().splitlines()[-1]
assert any(text in context_line for text in ["Updated context", "Added new context"])

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this change needed ?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this change is from other commits. Can you rebase to main to clean it up?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I merged in the latest changes from main and this change is shown up as diff. Change is from this PR: https://github.com/aws/sagemaker-hyperpod-cli/pull/184/files

* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
@rsareddy0329
rsareddy0329 merged commit 17cfdbd into mainAug 6, 2025
4 of 5 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@rsareddy0329@nargokul@pintaoz-aws@mollyheamazon
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Merge Documentation changes to main for Launch - #196

Merged
rsareddy0329 merged 7 commits into
mainfrom
documentation-with-new-changes
Aug 6, 2025
Merged

Merge Documentation changes to main for Launch#196
rsareddy0329 merged 7 commits into
mainfrom
documentation-with-new-changes

Conversation

@rsareddy0329

Copy link
Copy Markdown
Collaborator

PR to merge all the documentation change to main branch for public launch

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.

rsareddy0329and others added 4 commits August 5, 2025 16:00
… 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 <pintaoz@amazon.com>
---------
Co-authored-by: Zhaoqi <zhaoqiwang.baruch@gmail.com>
Co-authored-by: pintaoz-aws <167920275+pintaoz-aws@users.noreply.github.com>
Co-authored-by: pintaoz <pintaoz@amazon.com>
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
* 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 <pintaoz@amazon.com>
---------
Co-authored-by: Zhaoqi <zhaoqiwang.baruch@gmail.com>
Co-authored-by: pintaoz-aws <167920275+pintaoz-aws@users.noreply.github.com>
Co-authored-by: pintaoz <pintaoz@amazon.com>
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
@rsareddy0329
rsareddy0329 requested a review from a team as a code ownerAugust 6, 2025 00:04
Comment thread.gitignore
/.mypy_cache

/doc/_apidoc/
doc/_build/

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this needs to be /doc/_build/ here?

@rsareddy0329rsareddy0329Aug 6, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is mainly to make sure _build is ignored in git Version control system

Comment threaddoc/installation.md
source {venv-name}/bin/activate
```
```{note}
Remember to activate your virtual environment (source {venv-name}/bin/activate) each time you want to use the HyperPod CLI and SDK if you chose the virtual environment installation method.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add code quote around source {venv-name}/bin/activate

Comment threaddoc/training.md
--image pytorch/pytorch:latest \
```
````
````{tab-item} SDK

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is SDK code keeping parity with CLI here?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be a fast-follow item

Comment threaddoc/inference.md
```
````

````{tab-item} SDK

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like SDK code here is still using some optional variables

Comment threaddoc/inference.md
````

````{tab-item} SDK
```python

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to update SDK code here too

Comment threaddoc/inference.md
# Custom endpoint
hyp list-pods hyp-custom-endpoint
```
````

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing SDK code here

Comment threaddoc/inference.md
# Custom endpoint
hyp get-logs hyp-custom-endpoint --pod-name <pod-name>
```
````

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing SDK code here

Comment threaddoc/cli_training.md

List all HyperPod PyTorch jobs in a namespace.

#### Syntax

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like Syntax is even bigger then hyp list hyp-pytorch-job, not sure why the rendering is like that

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup, mainly CSS changes required.
would be a fast follow as well.

Comment threaddoc/index.md
:::

:::{grid-item-card} HyperPod Developer Guide
:link: https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link seems to be the same as the workshop. Maybe needs an update?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, checking with Shweta on this.

* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
Comment threaddoc/inference.md Outdated
Comment on lines +134 to +143
When creating an inference endpoint, you'll need to specify:

- **endpoint-name**: Unique identifier for your endpoint
- **instance-type**: The EC2 instance type to use
- **model-id** (JumpStart): ID of the pre-trained JumpStart model
- **image-uri** (Custom): Docker image containing your inference code
- **model-name** (Custom): Name of model to create on SageMaker
- **model-source-type** (Custom): Source type: fsx or s3
- **model-volume-mount-name** (Custom): Name of the model volume mount
- **container-port** (Custom): Port on which the model server listens

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we separate this into 2

  1. Parameters required for Jumpstart
  2. Parameters required for Custom

Comment threaddoc/installation.md Outdated
Comment on lines +15 to +16
### Supported ML Frameworks
- PyTorch (version ≥ 1.10)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Supported ML Frameworks for Training maybe

Comment on lines -30 to -39
def test_set_cluster_context(self, cluster_name):
"""Test setting cluster context."""
result = execute_command([
"hyp", "set-cluster-context",
"--cluster-name", cluster_name
])
assert result.returncode == 0
context_line = result.stdout.strip().splitlines()[-1]
assert any(text in context_line for text in ["Updated context", "Added new context"])

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this change needed ?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this change is from other commits. Can you rebase to main to clean it up?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I merged in the latest changes from main and this change is shown up as diff. Change is from this PR: https://github.com/aws/sagemaker-hyperpod-cli/pull/184/files

* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
@rsareddy0329
rsareddy0329 merged commit 17cfdbd into mainAug 6, 2025
4 of 5 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@rsareddy0329@nargokul@pintaoz-aws@mollyheamazon
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Merge Documentation changes to main for Launch - #196

Merged
rsareddy0329 merged 7 commits into
mainfrom
documentation-with-new-changes
Aug 6, 2025
Merged

Merge Documentation changes to main for Launch#196
rsareddy0329 merged 7 commits into
mainfrom
documentation-with-new-changes

Conversation

@rsareddy0329

Copy link
Copy Markdown
Collaborator

PR to merge all the documentation change to main branch for public launch

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.

rsareddy0329and others added 4 commits August 5, 2025 16:00
… 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 <pintaoz@amazon.com>
---------
Co-authored-by: Zhaoqi <zhaoqiwang.baruch@gmail.com>
Co-authored-by: pintaoz-aws <167920275+pintaoz-aws@users.noreply.github.com>
Co-authored-by: pintaoz <pintaoz@amazon.com>
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
* 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 <pintaoz@amazon.com>
---------
Co-authored-by: Zhaoqi <zhaoqiwang.baruch@gmail.com>
Co-authored-by: pintaoz-aws <167920275+pintaoz-aws@users.noreply.github.com>
Co-authored-by: pintaoz <pintaoz@amazon.com>
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
@rsareddy0329
rsareddy0329 requested a review from a team as a code ownerAugust 6, 2025 00:04
Comment thread.gitignore
/.mypy_cache

/doc/_apidoc/
doc/_build/

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this needs to be /doc/_build/ here?

@rsareddy0329rsareddy0329Aug 6, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is mainly to make sure _build is ignored in git Version control system

Comment threaddoc/installation.md
source {venv-name}/bin/activate
```
```{note}
Remember to activate your virtual environment (source {venv-name}/bin/activate) each time you want to use the HyperPod CLI and SDK if you chose the virtual environment installation method.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add code quote around source {venv-name}/bin/activate

Comment threaddoc/training.md
--image pytorch/pytorch:latest \
```
````
````{tab-item} SDK

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is SDK code keeping parity with CLI here?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be a fast-follow item

Comment threaddoc/inference.md
```
````

````{tab-item} SDK

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like SDK code here is still using some optional variables

Comment threaddoc/inference.md
````

````{tab-item} SDK
```python

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to update SDK code here too

Comment threaddoc/inference.md
# Custom endpoint
hyp list-pods hyp-custom-endpoint
```
````

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing SDK code here

Comment threaddoc/inference.md
# Custom endpoint
hyp get-logs hyp-custom-endpoint --pod-name <pod-name>
```
````

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing SDK code here

Comment threaddoc/cli_training.md

List all HyperPod PyTorch jobs in a namespace.

#### Syntax

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like Syntax is even bigger then hyp list hyp-pytorch-job, not sure why the rendering is like that

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup, mainly CSS changes required.
would be a fast follow as well.

Comment threaddoc/index.md
:::

:::{grid-item-card} HyperPod Developer Guide
:link: https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link seems to be the same as the workshop. Maybe needs an update?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, checking with Shweta on this.

* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
Comment threaddoc/inference.md Outdated
Comment on lines +134 to +143
When creating an inference endpoint, you'll need to specify:

- **endpoint-name**: Unique identifier for your endpoint
- **instance-type**: The EC2 instance type to use
- **model-id** (JumpStart): ID of the pre-trained JumpStart model
- **image-uri** (Custom): Docker image containing your inference code
- **model-name** (Custom): Name of model to create on SageMaker
- **model-source-type** (Custom): Source type: fsx or s3
- **model-volume-mount-name** (Custom): Name of the model volume mount
- **container-port** (Custom): Port on which the model server listens

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we separate this into 2

  1. Parameters required for Jumpstart
  2. Parameters required for Custom

Comment threaddoc/installation.md Outdated
Comment on lines +15 to +16
### Supported ML Frameworks
- PyTorch (version ≥ 1.10)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Supported ML Frameworks for Training maybe

Comment on lines -30 to -39
def test_set_cluster_context(self, cluster_name):
"""Test setting cluster context."""
result = execute_command([
"hyp", "set-cluster-context",
"--cluster-name", cluster_name
])
assert result.returncode == 0
context_line = result.stdout.strip().splitlines()[-1]
assert any(text in context_line for text in ["Updated context", "Added new context"])

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this change needed ?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this change is from other commits. Can you rebase to main to clean it up?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I merged in the latest changes from main and this change is shown up as diff. Change is from this PR: https://github.com/aws/sagemaker-hyperpod-cli/pull/184/files

* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
@rsareddy0329
rsareddy0329 merged commit 17cfdbd into mainAug 6, 2025
4 of 5 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@rsareddy0329@nargokul@pintaoz-aws@mollyheamazon
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Merge Documentation changes to main for Launch - #196

Merged
rsareddy0329 merged 7 commits into
mainfrom
documentation-with-new-changes
Aug 6, 2025
Merged

Merge Documentation changes to main for Launch#196
rsareddy0329 merged 7 commits into
mainfrom
documentation-with-new-changes

Conversation

@rsareddy0329

Copy link
Copy Markdown
Collaborator

PR to merge all the documentation change to main branch for public launch

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.

rsareddy0329and others added 4 commits August 5, 2025 16:00
… 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 <pintaoz@amazon.com>
---------
Co-authored-by: Zhaoqi <zhaoqiwang.baruch@gmail.com>
Co-authored-by: pintaoz-aws <167920275+pintaoz-aws@users.noreply.github.com>
Co-authored-by: pintaoz <pintaoz@amazon.com>
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
* 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 <pintaoz@amazon.com>
---------
Co-authored-by: Zhaoqi <zhaoqiwang.baruch@gmail.com>
Co-authored-by: pintaoz-aws <167920275+pintaoz-aws@users.noreply.github.com>
Co-authored-by: pintaoz <pintaoz@amazon.com>
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
@rsareddy0329
rsareddy0329 requested a review from a team as a code ownerAugust 6, 2025 00:04
Comment thread.gitignore
/.mypy_cache

/doc/_apidoc/
doc/_build/

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this needs to be /doc/_build/ here?

@rsareddy0329rsareddy0329Aug 6, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is mainly to make sure _build is ignored in git Version control system

Comment threaddoc/installation.md
source {venv-name}/bin/activate
```
```{note}
Remember to activate your virtual environment (source {venv-name}/bin/activate) each time you want to use the HyperPod CLI and SDK if you chose the virtual environment installation method.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add code quote around source {venv-name}/bin/activate

Comment threaddoc/training.md
--image pytorch/pytorch:latest \
```
````
````{tab-item} SDK

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is SDK code keeping parity with CLI here?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be a fast-follow item

Comment threaddoc/inference.md
```
````

````{tab-item} SDK

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like SDK code here is still using some optional variables

Comment threaddoc/inference.md
````

````{tab-item} SDK
```python

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to update SDK code here too

Comment threaddoc/inference.md
# Custom endpoint
hyp list-pods hyp-custom-endpoint
```
````

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing SDK code here

Comment threaddoc/inference.md
# Custom endpoint
hyp get-logs hyp-custom-endpoint --pod-name <pod-name>
```
````

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing SDK code here

Comment threaddoc/cli_training.md

List all HyperPod PyTorch jobs in a namespace.

#### Syntax

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like Syntax is even bigger then hyp list hyp-pytorch-job, not sure why the rendering is like that

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup, mainly CSS changes required.
would be a fast follow as well.

Comment threaddoc/index.md
:::

:::{grid-item-card} HyperPod Developer Guide
:link: https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link seems to be the same as the workshop. Maybe needs an update?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, checking with Shweta on this.

* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
Comment threaddoc/inference.md Outdated
Comment on lines +134 to +143
When creating an inference endpoint, you'll need to specify:

- **endpoint-name**: Unique identifier for your endpoint
- **instance-type**: The EC2 instance type to use
- **model-id** (JumpStart): ID of the pre-trained JumpStart model
- **image-uri** (Custom): Docker image containing your inference code
- **model-name** (Custom): Name of model to create on SageMaker
- **model-source-type** (Custom): Source type: fsx or s3
- **model-volume-mount-name** (Custom): Name of the model volume mount
- **container-port** (Custom): Port on which the model server listens

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we separate this into 2

  1. Parameters required for Jumpstart
  2. Parameters required for Custom

Comment threaddoc/installation.md Outdated
Comment on lines +15 to +16
### Supported ML Frameworks
- PyTorch (version ≥ 1.10)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Supported ML Frameworks for Training maybe

Comment on lines -30 to -39
def test_set_cluster_context(self, cluster_name):
"""Test setting cluster context."""
result = execute_command([
"hyp", "set-cluster-context",
"--cluster-name", cluster_name
])
assert result.returncode == 0
context_line = result.stdout.strip().splitlines()[-1]
assert any(text in context_line for text in ["Updated context", "Added new context"])

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this change needed ?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this change is from other commits. Can you rebase to main to clean it up?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I merged in the latest changes from main and this change is shown up as diff. Change is from this PR: https://github.com/aws/sagemaker-hyperpod-cli/pull/184/files

* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
@rsareddy0329
rsareddy0329 merged commit 17cfdbd into mainAug 6, 2025
4 of 5 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@rsareddy0329@nargokul@pintaoz-aws@mollyheamazon
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Merge Documentation changes to main for Launch - #196

Merged
rsareddy0329 merged 7 commits into
mainfrom
documentation-with-new-changes
Aug 6, 2025
Merged

Merge Documentation changes to main for Launch#196
rsareddy0329 merged 7 commits into
mainfrom
documentation-with-new-changes

Conversation

@rsareddy0329

Copy link
Copy Markdown
Collaborator

PR to merge all the documentation change to main branch for public launch

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.

rsareddy0329and others added 4 commits August 5, 2025 16:00
… 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 <pintaoz@amazon.com>
---------
Co-authored-by: Zhaoqi <zhaoqiwang.baruch@gmail.com>
Co-authored-by: pintaoz-aws <167920275+pintaoz-aws@users.noreply.github.com>
Co-authored-by: pintaoz <pintaoz@amazon.com>
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
* 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 <pintaoz@amazon.com>
---------
Co-authored-by: Zhaoqi <zhaoqiwang.baruch@gmail.com>
Co-authored-by: pintaoz-aws <167920275+pintaoz-aws@users.noreply.github.com>
Co-authored-by: pintaoz <pintaoz@amazon.com>
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
@rsareddy0329
rsareddy0329 requested a review from a team as a code ownerAugust 6, 2025 00:04
Comment thread.gitignore
/.mypy_cache

/doc/_apidoc/
doc/_build/

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this needs to be /doc/_build/ here?

@rsareddy0329rsareddy0329Aug 6, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is mainly to make sure _build is ignored in git Version control system

Comment threaddoc/installation.md
source {venv-name}/bin/activate
```
```{note}
Remember to activate your virtual environment (source {venv-name}/bin/activate) each time you want to use the HyperPod CLI and SDK if you chose the virtual environment installation method.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add code quote around source {venv-name}/bin/activate

Comment threaddoc/training.md
--image pytorch/pytorch:latest \
```
````
````{tab-item} SDK

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is SDK code keeping parity with CLI here?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be a fast-follow item

Comment threaddoc/inference.md
```
````

````{tab-item} SDK

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like SDK code here is still using some optional variables

Comment threaddoc/inference.md
````

````{tab-item} SDK
```python

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to update SDK code here too

Comment threaddoc/inference.md
# Custom endpoint
hyp list-pods hyp-custom-endpoint
```
````

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing SDK code here

Comment threaddoc/inference.md
# Custom endpoint
hyp get-logs hyp-custom-endpoint --pod-name <pod-name>
```
````

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing SDK code here

Comment threaddoc/cli_training.md

List all HyperPod PyTorch jobs in a namespace.

#### Syntax

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like Syntax is even bigger then hyp list hyp-pytorch-job, not sure why the rendering is like that

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup, mainly CSS changes required.
would be a fast follow as well.

Comment threaddoc/index.md
:::

:::{grid-item-card} HyperPod Developer Guide
:link: https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link seems to be the same as the workshop. Maybe needs an update?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, checking with Shweta on this.

* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
Comment threaddoc/inference.md Outdated
Comment on lines +134 to +143
When creating an inference endpoint, you'll need to specify:

- **endpoint-name**: Unique identifier for your endpoint
- **instance-type**: The EC2 instance type to use
- **model-id** (JumpStart): ID of the pre-trained JumpStart model
- **image-uri** (Custom): Docker image containing your inference code
- **model-name** (Custom): Name of model to create on SageMaker
- **model-source-type** (Custom): Source type: fsx or s3
- **model-volume-mount-name** (Custom): Name of the model volume mount
- **container-port** (Custom): Port on which the model server listens

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we separate this into 2

  1. Parameters required for Jumpstart
  2. Parameters required for Custom

Comment threaddoc/installation.md Outdated
Comment on lines +15 to +16
### Supported ML Frameworks
- PyTorch (version ≥ 1.10)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Supported ML Frameworks for Training maybe

Comment on lines -30 to -39
def test_set_cluster_context(self, cluster_name):
"""Test setting cluster context."""
result = execute_command([
"hyp", "set-cluster-context",
"--cluster-name", cluster_name
])
assert result.returncode == 0
context_line = result.stdout.strip().splitlines()[-1]
assert any(text in context_line for text in ["Updated context", "Added new context"])

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this change needed ?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this change is from other commits. Can you rebase to main to clean it up?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I merged in the latest changes from main and this change is shown up as diff. Change is from this PR: https://github.com/aws/sagemaker-hyperpod-cli/pull/184/files

* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
@rsareddy0329
rsareddy0329 merged commit 17cfdbd into mainAug 6, 2025
4 of 5 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@rsareddy0329@nargokul@pintaoz-aws@mollyheamazon
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Merge Documentation changes to main for Launch - #196

Merged
rsareddy0329 merged 7 commits into
mainfrom
documentation-with-new-changes
Aug 6, 2025
Merged

Merge Documentation changes to main for Launch#196
rsareddy0329 merged 7 commits into
mainfrom
documentation-with-new-changes

Conversation

@rsareddy0329

Copy link
Copy Markdown
Collaborator

PR to merge all the documentation change to main branch for public launch

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.

rsareddy0329and others added 4 commits August 5, 2025 16:00
… 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 <pintaoz@amazon.com>
---------
Co-authored-by: Zhaoqi <zhaoqiwang.baruch@gmail.com>
Co-authored-by: pintaoz-aws <167920275+pintaoz-aws@users.noreply.github.com>
Co-authored-by: pintaoz <pintaoz@amazon.com>
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
* 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 <pintaoz@amazon.com>
---------
Co-authored-by: Zhaoqi <zhaoqiwang.baruch@gmail.com>
Co-authored-by: pintaoz-aws <167920275+pintaoz-aws@users.noreply.github.com>
Co-authored-by: pintaoz <pintaoz@amazon.com>
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
@rsareddy0329
rsareddy0329 requested a review from a team as a code ownerAugust 6, 2025 00:04
Comment thread.gitignore
/.mypy_cache

/doc/_apidoc/
doc/_build/

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this needs to be /doc/_build/ here?

@rsareddy0329rsareddy0329Aug 6, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is mainly to make sure _build is ignored in git Version control system

Comment threaddoc/installation.md
source {venv-name}/bin/activate
```
```{note}
Remember to activate your virtual environment (source {venv-name}/bin/activate) each time you want to use the HyperPod CLI and SDK if you chose the virtual environment installation method.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add code quote around source {venv-name}/bin/activate

Comment threaddoc/training.md
--image pytorch/pytorch:latest \
```
````
````{tab-item} SDK

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is SDK code keeping parity with CLI here?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be a fast-follow item

Comment threaddoc/inference.md
```
````

````{tab-item} SDK

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like SDK code here is still using some optional variables

Comment threaddoc/inference.md
````

````{tab-item} SDK
```python

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to update SDK code here too

Comment threaddoc/inference.md
# Custom endpoint
hyp list-pods hyp-custom-endpoint
```
````

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing SDK code here

Comment threaddoc/inference.md
# Custom endpoint
hyp get-logs hyp-custom-endpoint --pod-name <pod-name>
```
````

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing SDK code here

Comment threaddoc/cli_training.md

List all HyperPod PyTorch jobs in a namespace.

#### Syntax

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like Syntax is even bigger then hyp list hyp-pytorch-job, not sure why the rendering is like that

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup, mainly CSS changes required.
would be a fast follow as well.

Comment threaddoc/index.md
:::

:::{grid-item-card} HyperPod Developer Guide
:link: https://catalog.workshops.aws/sagemaker-hyperpod-eks/en-US

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link seems to be the same as the workshop. Maybe needs an update?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, checking with Shweta on this.

* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
Comment threaddoc/inference.md Outdated
Comment on lines +134 to +143
When creating an inference endpoint, you'll need to specify:

- **endpoint-name**: Unique identifier for your endpoint
- **instance-type**: The EC2 instance type to use
- **model-id** (JumpStart): ID of the pre-trained JumpStart model
- **image-uri** (Custom): Docker image containing your inference code
- **model-name** (Custom): Name of model to create on SageMaker
- **model-source-type** (Custom): Source type: fsx or s3
- **model-volume-mount-name** (Custom): Name of the model volume mount
- **container-port** (Custom): Port on which the model server listens

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we separate this into 2

  1. Parameters required for Jumpstart
  2. Parameters required for Custom

Comment threaddoc/installation.md Outdated
Comment on lines +15 to +16
### Supported ML Frameworks
- PyTorch (version ≥ 1.10)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Supported ML Frameworks for Training maybe

Comment on lines -30 to -39
def test_set_cluster_context(self, cluster_name):
"""Test setting cluster context."""
result = execute_command([
"hyp", "set-cluster-context",
"--cluster-name", cluster_name
])
assert result.returncode == 0
context_line = result.stdout.strip().splitlines()[-1]
assert any(text in context_line for text in ["Updated context", "Added new context"])

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this change needed ?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this change is from other commits. Can you rebase to main to clean it up?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I merged in the latest changes from main and this change is shown up as diff. Change is from this PR: https://github.com/aws/sagemaker-hyperpod-cli/pull/184/files

* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
* Documentation Fixes
---------
Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
@rsareddy0329
rsareddy0329 merged commit 17cfdbd into mainAug 6, 2025
4 of 5 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@rsareddy0329@nargokul@pintaoz-aws@mollyheamazon