doc: improvements on the docstring of ModelStep #3137

navaj0 · 2022-05-25T20:54:51Z

Issue #, if available: 3129

Description of changes:

remove the README under the workflow folder, which is outdated.
add back the docstring of RegisterModel step
polish the docstring of ModelStep

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

[x ] 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.

sagemaker-bot · 2022-05-25T20:58:49Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-25T21:05:32Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-25T21:40:14Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-pr
Commit ID: fdcd90f
Result: FAILED
Build Logs (available for 30 days)

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

sagemaker-bot · 2022-05-25T21:42:39Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-25T21:46:17Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-25T21:55:55Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-25T22:06:00Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-25T22:07:33Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-25T22:20:35Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-25T22:30:31Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-25T22:37:25Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-pr
Commit ID: 4a5d246
Result: FAILED
Build Logs (available for 30 days)

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

sagemaker-bot · 2022-05-25T22:38:45Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-25T22:59:02Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-25T23:14:17Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-25T23:18:39Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-25T23:34:44Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-notebook-tests
Commit ID: 4a5d246
Result: FAILED
Build Logs (available for 30 days)

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

sagemaker-bot · 2022-05-25T23:47:33Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-25T23:54:25Z

AWS CodeBuild CI Report

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

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

codecov-commenter · 2022-05-26T00:17:57Z

Codecov Report

Merging #3137 (6cb845c) into master (630f2c6) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #3137      +/-   ##
==========================================
- Coverage   89.62%   89.62%   -0.01%     
==========================================
  Files         200      200              
  Lines       17391    17389       -2     
==========================================
- Hits        15587    15585       -2     
  Misses       1804     1804

Impacted Files	Coverage Δ
src/sagemaker/model.py	`92.58% <ø> (ø)`
src/sagemaker/workflow/model_step.py	`93.47% <ø> (ø)`
src/sagemaker/workflow/step_collections.py	`97.87% <ø> (-0.09%)`	⬇️

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 630f2c6...6cb845c. Read the comment docs.

sagemaker-bot · 2022-05-26T00:18:01Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-26T00:20:22Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-26T00:35:45Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-26T00:44:33Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-05-26T00:50:32Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-pr
Commit ID: f5152a0
Result: SUCCEEDED
Build Logs (available for 30 days)

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

qidewenwhen · 2022-05-26T16:08:59Z

src/sagemaker/model.py

+                For more information about tags, see
+                `boto3 documentation <https://boto3.amazonaws.com/v1/documentation/\
+api/latest/reference/services/sagemaker.html#SageMaker.Client.add_tags>`_
+


We have checked this in the pages built by sphinx right?

qidewenwhen · 2022-05-26T16:09:32Z

src/sagemaker/workflow/model_step.py

+                under the :class:`~sagemaker.workflow.pipeline_context.PipelineSession`. Example::
+
+                     model = Model(session=PipelineSession())
+                     model_step = ModelStep(step_args=model.register())


model = Model(sagemaker_session=PipelineSession()) ?

updated it.

sagemaker-bot · 2022-06-06T21:14:15Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-06-06T21:24:40Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-pr
Commit ID: 6cb845c
Result: SUCCEEDED
Build Logs (available for 30 days)

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

sagemaker-bot · 2022-06-06T21:38:28Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-06-06T21:58:22Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-06-06T23:42:55Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-06-08T00:41:55Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-06-08T02:21:13Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-06-08T21:48:11Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-06-08T23:22:10Z

AWS CodeBuild CI Report

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

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

Co-authored-by: Zhankui Lu <[email protected]>

navaj0 requested review from qidewenwhen and mufaddal-rohawala May 25, 2022 20:55

navaj0 force-pushed the pipeline_doc branch from 600e100 to fdcd90f Compare May 25, 2022 21:01

navaj0 force-pushed the pipeline_doc branch from fdcd90f to cfbb0dc Compare May 25, 2022 21:52

navaj0 force-pushed the pipeline_doc branch from cfbb0dc to 4a5d246 Compare May 25, 2022 22:26

qidewenwhen mentioned this pull request May 25, 2022

RegisterModel Pipeline Step Documentation is Broken #3129

Closed

jerrypeng7773 approved these changes May 25, 2022

View reviewed changes

navaj0 force-pushed the pipeline_doc branch from 4a5d246 to f5152a0 Compare May 25, 2022 23:30

qidewenwhen reviewed May 26, 2022

View reviewed changes

doc: improvements on the docstring of ModelStep

6cb845c

navaj0 force-pushed the pipeline_doc branch from f5152a0 to 6cb845c Compare June 6, 2022 20:50

qidewenwhen approved these changes Jun 6, 2022

View reviewed changes

mufaddal-rohawala requested a review from BasilBeirouti June 7, 2022 16:53

BasilBeirouti approved these changes Jun 7, 2022

View reviewed changes

navaj0 removed the request for review from mufaddal-rohawala June 8, 2022 00:31

mufaddal-rohawala approved these changes Jun 10, 2022

View reviewed changes

mufaddal-rohawala merged commit b2d4744 into aws:master Jun 10, 2022

jerrypeng7773 pushed a commit to jerrypeng7773/sagemaker-python-sdk that referenced this pull request Aug 8, 2022

doc: improvements on the docstring of ModelStep (aws#3137)

1431add

Co-authored-by: Zhankui Lu <[email protected]>

doc: improvements on the docstring of ModelStep #3137

doc: improvements on the docstring of ModelStep #3137

Conversation

navaj0 commented May 25, 2022

Merge Checklist

General

Tests

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 25, 2022

AWS CodeBuild CI Report

codecov-commenter commented May 26, 2022 • edited Loading

Codecov Report

sagemaker-bot commented May 26, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2022

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2022

AWS CodeBuild CI Report

qidewenwhen May 26, 2022

Choose a reason for hiding this comment

navaj0 Jun 6, 2022

Choose a reason for hiding this comment

qidewenwhen May 26, 2022

Choose a reason for hiding this comment

navaj0 Jun 6, 2022

Choose a reason for hiding this comment

sagemaker-bot commented Jun 6, 2022

AWS CodeBuild CI Report

sagemaker-bot commented Jun 6, 2022

AWS CodeBuild CI Report

sagemaker-bot commented Jun 6, 2022

AWS CodeBuild CI Report

sagemaker-bot commented Jun 6, 2022

AWS CodeBuild CI Report

sagemaker-bot commented Jun 6, 2022

AWS CodeBuild CI Report

sagemaker-bot commented Jun 8, 2022

AWS CodeBuild CI Report

sagemaker-bot commented Jun 8, 2022

AWS CodeBuild CI Report

sagemaker-bot commented Jun 8, 2022

AWS CodeBuild CI Report

sagemaker-bot commented Jun 8, 2022

codecov-commenter commented May 26, 2022 •

edited

Loading