change: Disable displaying type hints in doc signature and add PipelineVariable annotations in docstring #3292

qidewenwhen · 2022-08-11T23:10:24Z

Issue #, if available: We've added PipelineVariable annotations in multiple classes' or methods' signature. However, it has made the python doc to be quite messy and hard to read. See: https://sagemaker.readthedocs.io/en/stable/api/training/estimators.html

Description of changes:

Disable displaying type hints in class signature in the python doc to keep it clean
Surface PipelineVariable type hint in docstring

Testing done: N/A

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.

sagemaker-bot · 2022-08-11T23:39:59Z

AWS CodeBuild CI Report

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

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

codecov-commenter · 2022-08-11T23:41:29Z

Codecov Report

Merging #3292 (cb0dde7) into master (38b4916) will decrease coverage by 0.37%.
The diff coverage is 95.95%.

❗ Current head cb0dde7 differs from pull request most recent head 4a52432. Consider uploading reports for the commit 4a52432 to get more accurate results

@@            Coverage Diff             @@
##           master    #3292      +/-   ##
==========================================
- Coverage   89.40%   89.03%   -0.38%     
==========================================
  Files         848      203     -645     
  Lines       72563    18313   -54250     
==========================================
- Hits        64877    16305   -48572     
+ Misses       7686     2008    -5678

Impacted Files	Coverage Δ
src/sagemaker/jumpstart/types.py	`94.37% <0.00%> (ø)`
src/sagemaker/network.py	`100.00% <ø> (ø)`
src/sagemaker/processing.py	`94.33% <ø> (ø)`
...agemaker/serverless/serverless_inference_config.py	`100.00% <ø> (ø)`
src/sagemaker/spark/processing.py	`98.62% <ø> (ø)`
src/sagemaker/transformer.py	`94.47% <ø> (ø)`
src/sagemaker/workflow/entities.py	`97.43% <ø> (ø)`
src/sagemaker/workflow/step_collections.py	`93.87% <ø> (ø)`
src/sagemaker/job.py	`90.00% <75.00%> (-0.55%)`	⬇️
src/sagemaker/tensorflow/estimator.py	`92.18% <75.00%> (-0.56%)`	⬇️
... and 708 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

sagemaker-bot · 2022-08-11T23:52:07Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-11T23:54:45Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T00:16:51Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T00:18:06Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T01:13:19Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T01:31:35Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T01:35:48Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T01:53:47Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T02:23:14Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T02:33:08Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T02:37:39Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T03:01:52Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T03:28:48Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T04:21:05Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T04:35:13Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T04:42:08Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T04:58:47Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T06:44:54Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T16:35:23Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-12T17:18:57Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-18T18:48:54Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-18T20:17:21Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-24T22:09:35Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-24T22:21:52Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-24T22:27:57Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-24T22:31:06Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-24T22:46:14Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-25T21:05:23Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-25T21:12:35Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-25T21:22:21Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-25T21:26:25Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-08-25T21:44:13Z

AWS CodeBuild CI Report

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

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

…neVariable annotations in docstring

sagemaker-bot · 2022-09-03T02:32:56Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-09-03T02:36:16Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-09-03T02:51:00Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-09-03T03:10:02Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-09-03T03:20:11Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-09-20T19:44:24Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-09-20T20:08:55Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-09-20T20:21:42Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-09-20T20:24:33Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-09-20T20:47:01Z

AWS CodeBuild CI Report

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

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

…annotations in docstring (aws#3292) Co-authored-by: Dewen Qi <[email protected]>

qidewenwhen marked this pull request as draft August 11, 2022 23:11

qidewenwhen force-pushed the docstr branch from 8792ae2 to 3384534 Compare August 12, 2022 00:42

qidewenwhen force-pushed the docstr branch from 3384534 to d87d08f Compare August 12, 2022 01:53

qidewenwhen force-pushed the docstr branch from d87d08f to 5ff14b2 Compare August 12, 2022 03:22

qidewenwhen force-pushed the docstr branch 2 times, most recently from 514fb60 to a3c0549 Compare August 12, 2022 03:52

qidewenwhen marked this pull request as ready for review August 12, 2022 03:52

qidewenwhen force-pushed the docstr branch from a3c0549 to f93e767 Compare August 15, 2022 18:57

qidewenwhen force-pushed the docstr branch from 12773ca to 39436cc Compare August 24, 2022 21:40

navaj0 approved these changes Aug 25, 2022

View reviewed changes

change: Disable displaying type hints in doc signature and add Pipeli…

4a52432

…neVariable annotations in docstring

qidewenwhen force-pushed the docstr branch from 39436cc to 4a52432 Compare September 3, 2022 02:02

shreyapandit approved these changes Sep 20, 2022

View reviewed changes

shreyapandit merged commit 9f400bd into aws:master Sep 20, 2022

JoseJuan98 pushed a commit to JoseJuan98/sagemaker-python-sdk that referenced this pull request Mar 4, 2023

change: Disable type hints in doc signature and add PipelineVariable …

4a36244

…annotations in docstring (aws#3292) Co-authored-by: Dewen Qi <[email protected]>

qidewenwhen deleted the docstr branch January 25, 2024 18:33

change: Disable displaying type hints in doc signature and add PipelineVariable annotations in docstring #3292

change: Disable displaying type hints in doc signature and add PipelineVariable annotations in docstring #3292

Uh oh!

Conversation

qidewenwhen commented Aug 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge Checklist

General

Tests

Uh oh!

sagemaker-bot commented Aug 11, 2022

AWS CodeBuild CI Report

Uh oh!

codecov-commenter commented Aug 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sagemaker-bot commented Aug 11, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 11, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 12, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 18, 2022

AWS CodeBuild CI Report

Uh oh!

qidewenwhen commented Aug 11, 2022 •

edited

Loading

codecov-commenter commented Aug 11, 2022 •

edited

Loading