Skip to content

documentation: smddp doc update - #2968

Merged
shreyapandit merged 1 commit into
aws:devfrom
mchoi8739:smddp-doc-fix
Mar 4, 2022
Merged

documentation: smddp doc update#2968
shreyapandit merged 1 commit into
aws:devfrom
mchoi8739:smddp-doc-fix

Conversation

@mchoi8739

Copy link
Copy Markdown
Contributor

Description of changes:
Add notes to the smdistributed.dataparallel APIs for TensorFlow

Testing done:
Screen Shot 2022-03-03 at 1 30 42 PM
Screen Shot 2022-03-03 at 1 31 07 PM

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

  • I have read the CONTRIBUTING doc
  • I certify that the changes I am introducing will be backword compatible, and I have discussed concerns about this, if any, with the Python SDK team
  • I used the commit message format described in CONTRIBUTING
  • I have passed the region in to all S3 and STS clients that I've initialized as part of this change.
  • I have updated any necessary documentation, including READMEs and API docs (if appropriate)

Tests

  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have added unit and/or integration tests as appropriate to ensure backward compatibility of the changes
  • I have checked that my tests are not configured for a specific region or account (if appropriate)
  • I have used unique_name_from_base to create resource names in integ tests (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@mchoi8739 mchoi8739 changed the title Smddp doc fix documentation: smddp doc update Mar 3, 2022

@Arjunbala Arjunbala left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Looks good to me. Thanks!

@sagemaker-bot

Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-notebook-tests
  • Commit ID: ec2894c
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot

Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: ec2894c
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot

Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-slow-tests
  • Commit ID: 5e13e13
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

Merging #2968 (5e13e13) into dev (b9f90dc) will decrease coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #2968      +/-   ##
==========================================
- Coverage   89.81%   89.80%   -0.01%     
==========================================
  Files         196      196              
  Lines       16564    16564              
==========================================
- Hits        14877    14876       -1     
- Misses       1687     1688       +1     
Impacted Files Coverage Δ
src/sagemaker/session.py 70.39% <0.00%> (-0.08%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b9f90dc...5e13e13. Read the comment docs.

@sagemaker-bot

Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: 5e13e13
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot

Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-local-mode-tests
  • Commit ID: ec2894c
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot

Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-local-mode-tests
  • Commit ID: 5e13e13
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot

Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-slow-tests
  • Commit ID: ec2894c
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@shreyapandit
shreyapandit merged commit 6db3774 into aws:dev Mar 4, 2022
navinsoni pushed a commit that referenced this pull request Mar 9, 2022
jeniyat added a commit that referenced this pull request Mar 18, 2022
* change: update code to get commit_id in codepipeline (#2961)

* feature: Data Serializer (#2956)

* change: reorganize test files for workflow (#2960)

Co-authored-by: Ben Crabtree <bencrab@amazon.com>
Co-authored-by: Navin Soni <navinsoni89@gmail.com>
Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>
Co-authored-by: Dewen Qi <qidewen@amazon.com>

* feature: TensorFlow 2.4 for Neo (#2861)

Co-authored-by: Ben Crabtree <bencrab@amazon.com>
Co-authored-by: Navin Soni <navinsoni89@gmail.com>
Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>

* fix: Remove sagemaker_job_name from hyperparameters in TrainingStep (#2950)

Co-authored-by: Payton Staub <pstaub@amazon.com>

* fix: Style update in DataSerializer (#2962)

* documentation: smddp doc update (#2968)

* fix: container env generation for S3 URI and add test for the same (#2971)

* documentation: update sagemaker training compiler docstring (#2969)

* feat: Python 3.9 for readthedocs (#2973)

Co-authored-by: Ben Crabtree <bencrab@amazon.com>
Co-authored-by: Navin Soni <navinsoni89@gmail.com>
Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>
Co-authored-by: Dewen Qi <qidewen@amazon.com>
Co-authored-by: Payton Staub <pstaub@amazon.com>
Co-authored-by: qidewenwhen <32910701+qidewenwhen@users.noreply.github.com>
Co-authored-by: Qingzi-Lan <83724147+Qingzi-Lan@users.noreply.github.com>
Co-authored-by: Payton Staub <staubhpa@gmail.com>

* fix doc structure

* archive 1.6.0 doc

* add new args, refs, and links

* fix version number

* incorp eng feedback, update docstrings, improve xref

* Trigger Build

* minor fix, trigger build again

* fix typo

Co-authored-by: Navin Soni <navinsoni89@gmail.com>
Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>
Co-authored-by: qidewenwhen <32910701+qidewenwhen@users.noreply.github.com>
Co-authored-by: Ben Crabtree <bencrab@amazon.com>
Co-authored-by: Dewen Qi <qidewen@amazon.com>
Co-authored-by: Qingzi-Lan <83724147+Qingzi-Lan@users.noreply.github.com>
Co-authored-by: Payton Staub <staubhpa@gmail.com>
Co-authored-by: Payton Staub <pstaub@amazon.com>
Co-authored-by: Shreya Pandit <shreya.pandit25@gmail.com>
Co-authored-by: Ahsan Khan <ahsan.al.zaki@gmail.com>
Co-authored-by: Mufaddal Rohawala <89424143+mufaddal-rohawala@users.noreply.github.com>
ahsan-z-khan added a commit to ahsan-z-khan/sagemaker-python-sdk that referenced this pull request Mar 23, 2022
* change: update code to get commit_id in codepipeline (aws#2961)

* feature: Data Serializer (aws#2956)

* change: reorganize test files for workflow (aws#2960)

Co-authored-by: Ben Crabtree <bencrab@amazon.com>
Co-authored-by: Navin Soni <navinsoni89@gmail.com>
Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>
Co-authored-by: Dewen Qi <qidewen@amazon.com>

* feature: TensorFlow 2.4 for Neo (aws#2861)

Co-authored-by: Ben Crabtree <bencrab@amazon.com>
Co-authored-by: Navin Soni <navinsoni89@gmail.com>
Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>

* fix: Remove sagemaker_job_name from hyperparameters in TrainingStep (aws#2950)

Co-authored-by: Payton Staub <pstaub@amazon.com>

* fix: Style update in DataSerializer (aws#2962)

* documentation: smddp doc update (aws#2968)

* fix: container env generation for S3 URI and add test for the same (aws#2971)

* documentation: update sagemaker training compiler docstring (aws#2969)

* feat: Python 3.9 for readthedocs (aws#2973)

Co-authored-by: Ben Crabtree <bencrab@amazon.com>
Co-authored-by: Navin Soni <navinsoni89@gmail.com>
Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>
Co-authored-by: Dewen Qi <qidewen@amazon.com>
Co-authored-by: Payton Staub <pstaub@amazon.com>
Co-authored-by: qidewenwhen <32910701+qidewenwhen@users.noreply.github.com>
Co-authored-by: Qingzi-Lan <83724147+Qingzi-Lan@users.noreply.github.com>
Co-authored-by: Payton Staub <staubhpa@gmail.com>

* fix doc structure

* archive 1.6.0 doc

* add new args, refs, and links

* fix version number

* incorp eng feedback, update docstrings, improve xref

* Trigger Build

* minor fix, trigger build again

* fix typo

Co-authored-by: Navin Soni <navinsoni89@gmail.com>
Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>
Co-authored-by: qidewenwhen <32910701+qidewenwhen@users.noreply.github.com>
Co-authored-by: Ben Crabtree <bencrab@amazon.com>
Co-authored-by: Dewen Qi <qidewen@amazon.com>
Co-authored-by: Qingzi-Lan <83724147+Qingzi-Lan@users.noreply.github.com>
Co-authored-by: Payton Staub <staubhpa@gmail.com>
Co-authored-by: Payton Staub <pstaub@amazon.com>
Co-authored-by: Shreya Pandit <shreya.pandit25@gmail.com>
Co-authored-by: Ahsan Khan <ahsan.al.zaki@gmail.com>
Co-authored-by: Mufaddal Rohawala <89424143+mufaddal-rohawala@users.noreply.github.com>
jerrypeng7773 pushed a commit to jerrypeng7773/sagemaker-python-sdk that referenced this pull request May 13, 2022
* change: update code to get commit_id in codepipeline (aws#2961)

* feature: Data Serializer (aws#2956)

* change: reorganize test files for workflow (aws#2960)

Co-authored-by: Ben Crabtree <bencrab@amazon.com>
Co-authored-by: Navin Soni <navinsoni89@gmail.com>
Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>
Co-authored-by: Dewen Qi <qidewen@amazon.com>

* feature: TensorFlow 2.4 for Neo (aws#2861)

Co-authored-by: Ben Crabtree <bencrab@amazon.com>
Co-authored-by: Navin Soni <navinsoni89@gmail.com>
Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>

* fix: Remove sagemaker_job_name from hyperparameters in TrainingStep (aws#2950)

Co-authored-by: Payton Staub <pstaub@amazon.com>

* fix: Style update in DataSerializer (aws#2962)

* documentation: smddp doc update (aws#2968)

* fix: container env generation for S3 URI and add test for the same (aws#2971)

* documentation: update sagemaker training compiler docstring (aws#2969)

* feat: Python 3.9 for readthedocs (aws#2973)

Co-authored-by: Ben Crabtree <bencrab@amazon.com>
Co-authored-by: Navin Soni <navinsoni89@gmail.com>
Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>
Co-authored-by: Dewen Qi <qidewen@amazon.com>
Co-authored-by: Payton Staub <pstaub@amazon.com>
Co-authored-by: qidewenwhen <32910701+qidewenwhen@users.noreply.github.com>
Co-authored-by: Qingzi-Lan <83724147+Qingzi-Lan@users.noreply.github.com>
Co-authored-by: Payton Staub <staubhpa@gmail.com>

* fix doc structure

* archive 1.6.0 doc

* add new args, refs, and links

* fix version number

* incorp eng feedback, update docstrings, improve xref

* Trigger Build

* minor fix, trigger build again

* fix typo

Co-authored-by: Navin Soni <navinsoni89@gmail.com>
Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>
Co-authored-by: qidewenwhen <32910701+qidewenwhen@users.noreply.github.com>
Co-authored-by: Ben Crabtree <bencrab@amazon.com>
Co-authored-by: Dewen Qi <qidewen@amazon.com>
Co-authored-by: Qingzi-Lan <83724147+Qingzi-Lan@users.noreply.github.com>
Co-authored-by: Payton Staub <staubhpa@gmail.com>
Co-authored-by: Payton Staub <pstaub@amazon.com>
Co-authored-by: Shreya Pandit <shreya.pandit25@gmail.com>
Co-authored-by: Ahsan Khan <ahsan.al.zaki@gmail.com>
Co-authored-by: Mufaddal Rohawala <89424143+mufaddal-rohawala@users.noreply.github.com>
Evan-W-ang added a commit to Evan-W-ang/sagemaker-python-sdk that referenced this pull request Jun 8, 2026
Evan-W-ang added a commit to Evan-W-ang/sagemaker-python-sdk that referenced this pull request Jun 8, 2026
* change: update code to get commit_id in codepipeline (aws#2961)

* feature: Data Serializer (aws#2956)

* change: reorganize test files for workflow (aws#2960)

Co-authored-by: Ben Crabtree <bencrab@amazon.com>
Co-authored-by: Navin Soni <navinsoni89@gmail.com>
Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>
Co-authored-by: Dewen Qi <qidewen@amazon.com>

* feature: TensorFlow 2.4 for Neo (aws#2861)

Co-authored-by: Ben Crabtree <bencrab@amazon.com>
Co-authored-by: Navin Soni <navinsoni89@gmail.com>
Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>

* fix: Remove sagemaker_job_name from hyperparameters in TrainingStep (aws#2950)

Co-authored-by: Payton Staub <pstaub@amazon.com>

* fix: Style update in DataSerializer (aws#2962)

* documentation: smddp doc update (aws#2968)

* fix: container env generation for S3 URI and add test for the same (aws#2971)

* documentation: update sagemaker training compiler docstring (aws#2969)

* feat: Python 3.9 for readthedocs (aws#2973)

Co-authored-by: Ben Crabtree <bencrab@amazon.com>
Co-authored-by: Navin Soni <navinsoni89@gmail.com>
Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>
Co-authored-by: Dewen Qi <qidewen@amazon.com>
Co-authored-by: Payton Staub <pstaub@amazon.com>
Co-authored-by: qidewenwhen <32910701+qidewenwhen@users.noreply.github.com>
Co-authored-by: Qingzi-Lan <83724147+Qingzi-Lan@users.noreply.github.com>
Co-authored-by: Payton Staub <staubhpa@gmail.com>

* fix doc structure

* archive 1.6.0 doc

* add new args, refs, and links

* fix version number

* incorp eng feedback, update docstrings, improve xref

* Trigger Build

* minor fix, trigger build again

* fix typo

Co-authored-by: Navin Soni <navinsoni89@gmail.com>
Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>
Co-authored-by: qidewenwhen <32910701+qidewenwhen@users.noreply.github.com>
Co-authored-by: Ben Crabtree <bencrab@amazon.com>
Co-authored-by: Dewen Qi <qidewen@amazon.com>
Co-authored-by: Qingzi-Lan <83724147+Qingzi-Lan@users.noreply.github.com>
Co-authored-by: Payton Staub <staubhpa@gmail.com>
Co-authored-by: Payton Staub <pstaub@amazon.com>
Co-authored-by: Shreya Pandit <shreya.pandit25@gmail.com>
Co-authored-by: Ahsan Khan <ahsan.al.zaki@gmail.com>
Co-authored-by: Mufaddal Rohawala <89424143+mufaddal-rohawala@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants