documentation: update sagemaker training compiler docstring #2969

mchoi8739 · 2022-03-04T04:01:44Z

Description of changes:

Improve the Training Compiler config docstring
In addition to that, rephrase the HuggingFace estimator docstring

Testing done:

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.

codecov-commenter · 2022-03-04T04:19:03Z

Codecov Report

Merging #2969 (bdc1296) into dev (6db3774) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##              dev    #2969      +/-   ##
==========================================
- 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/huggingface/estimator.py	`91.86% <ø> (ø)`
src/sagemaker/training_compiler/config.py	`86.11% <ø> (ø)`
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 6db3774...bdc1296. Read the comment docs.

sagemaker-bot · 2022-03-04T04:27:15Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-03-04T05:17:58Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-03-04T05:51:28Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-slow-tests
Commit ID: 642d149
Result: FAILED
Build Logs (available for 30 days)

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

mchoi8739 · 2022-03-04T08:27:48Z

The slow-test failure does not seem related to the changes in this PR.

…o sm-training-compiler-doc-update

sagemaker-bot · 2022-03-05T01:42:31Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-03-05T02:16:20Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-03-05T02:46:17Z

AWS CodeBuild CI Report

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

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

* 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 <[email protected]> Co-authored-by: Navin Soni <[email protected]> Co-authored-by: Jeniya Tabassum <[email protected]> Co-authored-by: Dewen Qi <[email protected]> * feature: TensorFlow 2.4 for Neo (#2861) Co-authored-by: Ben Crabtree <[email protected]> Co-authored-by: Navin Soni <[email protected]> Co-authored-by: Jeniya Tabassum <[email protected]> * fix: Remove sagemaker_job_name from hyperparameters in TrainingStep (#2950) Co-authored-by: Payton Staub <[email protected]> * 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 <[email protected]> Co-authored-by: Navin Soni <[email protected]> Co-authored-by: Jeniya Tabassum <[email protected]> Co-authored-by: Dewen Qi <[email protected]> Co-authored-by: Payton Staub <[email protected]> Co-authored-by: qidewenwhen <[email protected]> Co-authored-by: Qingzi-Lan <[email protected]> Co-authored-by: Payton Staub <[email protected]> * 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 <[email protected]> Co-authored-by: Jeniya Tabassum <[email protected]> Co-authored-by: qidewenwhen <[email protected]> Co-authored-by: Ben Crabtree <[email protected]> Co-authored-by: Dewen Qi <[email protected]> Co-authored-by: Qingzi-Lan <[email protected]> Co-authored-by: Payton Staub <[email protected]> Co-authored-by: Payton Staub <[email protected]> Co-authored-by: Shreya Pandit <[email protected]> Co-authored-by: Ahsan Khan <[email protected]> Co-authored-by: Mufaddal Rohawala <[email protected]>

* 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 <[email protected]> Co-authored-by: Navin Soni <[email protected]> Co-authored-by: Jeniya Tabassum <[email protected]> Co-authored-by: Dewen Qi <[email protected]> * feature: TensorFlow 2.4 for Neo (aws#2861) Co-authored-by: Ben Crabtree <[email protected]> Co-authored-by: Navin Soni <[email protected]> Co-authored-by: Jeniya Tabassum <[email protected]> * fix: Remove sagemaker_job_name from hyperparameters in TrainingStep (aws#2950) Co-authored-by: Payton Staub <[email protected]> * 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 <[email protected]> Co-authored-by: Navin Soni <[email protected]> Co-authored-by: Jeniya Tabassum <[email protected]> Co-authored-by: Dewen Qi <[email protected]> Co-authored-by: Payton Staub <[email protected]> Co-authored-by: qidewenwhen <[email protected]> Co-authored-by: Qingzi-Lan <[email protected]> Co-authored-by: Payton Staub <[email protected]> * 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 <[email protected]> Co-authored-by: Jeniya Tabassum <[email protected]> Co-authored-by: qidewenwhen <[email protected]> Co-authored-by: Ben Crabtree <[email protected]> Co-authored-by: Dewen Qi <[email protected]> Co-authored-by: Qingzi-Lan <[email protected]> Co-authored-by: Payton Staub <[email protected]> Co-authored-by: Payton Staub <[email protected]> Co-authored-by: Shreya Pandit <[email protected]> Co-authored-by: Ahsan Khan <[email protected]> Co-authored-by: Mufaddal Rohawala <[email protected]>

mchoi8739 added 3 commits March 3, 2022 16:17

documentation: update sm training compiler docstring

f32a23d

rephrase

0118c59

rephrase more

642d149

mchoi8739 added the type: documentation label Mar 4, 2022

mchoi8739 changed the title ~~Sm training compiler doc update~~ documentation: update sagemaker training compiler docstring Mar 4, 2022

Lokiiiiii approved these changes Mar 4, 2022

View reviewed changes

mchoi8739 added 2 commits March 4, 2022 17:17

Merge branch 'dev' of https://github.com/aws/sagemaker-python-sdk int…

2b3ef64

…o sm-training-compiler-doc-update

Trigger Build

bdc1296

ahsan-z-khan approved these changes Mar 7, 2022

View reviewed changes

jeniyat approved these changes Mar 7, 2022

View reviewed changes

jeniyat merged commit 169dffd into aws:dev Mar 7, 2022

navinsoni pushed a commit that referenced this pull request Mar 9, 2022

documentation: update sagemaker training compiler docstring (#2969)

4a93c8b

mchoi8739 deleted the sm-training-compiler-doc-update branch April 7, 2022 17:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

documentation: update sagemaker training compiler docstring #2969

documentation: update sagemaker training compiler docstring #2969

mchoi8739 commented Mar 4, 2022 •

edited

Loading

codecov-commenter commented Mar 4, 2022 •

edited

Loading

sagemaker-bot commented Mar 4, 2022

sagemaker-bot commented Mar 4, 2022

sagemaker-bot commented Mar 4, 2022

mchoi8739 commented Mar 4, 2022

sagemaker-bot commented Mar 5, 2022

sagemaker-bot commented Mar 5, 2022

sagemaker-bot commented Mar 5, 2022

documentation: update sagemaker training compiler docstring #2969

documentation: update sagemaker training compiler docstring #2969

Conversation

mchoi8739 commented Mar 4, 2022 • edited Loading

Merge Checklist

General

Tests

codecov-commenter commented Mar 4, 2022 • edited Loading

Codecov Report

sagemaker-bot commented Mar 4, 2022

AWS CodeBuild CI Report

sagemaker-bot commented Mar 4, 2022

AWS CodeBuild CI Report

sagemaker-bot commented Mar 4, 2022

AWS CodeBuild CI Report

mchoi8739 commented Mar 4, 2022

sagemaker-bot commented Mar 5, 2022

AWS CodeBuild CI Report

sagemaker-bot commented Mar 5, 2022

AWS CodeBuild CI Report

sagemaker-bot commented Mar 5, 2022

AWS CodeBuild CI Report

mchoi8739 commented Mar 4, 2022 •

edited

Loading

codecov-commenter commented Mar 4, 2022 •

edited

Loading