documentation: Jumpstart doc strings and added new sections #2893

evakravi · 2022-02-03T20:28:07Z

Issue #, if available:

Description of changes:

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.

Co-authored-by: Mufaddal Rohawala <muffi179@gmail.com>

Co-authored-by: Basil Beirouti <beirb@amazon.com>

aws#2790)

…ries (aws#2755) Co-authored-by: Payton Staub <pstaub@amazon.com> Co-authored-by: Ahsan Khan <ahsan.al.zaki@gmail.com>

Co-authored-by: Shreya Pandit <shreya.pandit25@gmail.com>

Co-authored-by: Basil Beirouti <beirb@amazon.com> Co-authored-by: Payton Staub <pstaub@amazon.com> Co-authored-by: Ahsan Khan <ahsan.al.zaki@gmail.com> Co-authored-by: Mufaddal Rohawala <89424143+mufaddal-rohawala@users.noreply.github.com> Co-authored-by: Basil Beirouti <BasilBeirouti@gmail.com> Co-authored-by: Payton Staub <staubhpa@gmail.com> Co-authored-by: Shreya Pandit <shreya.pandit25@gmail.com>

* update smdmp change log, archive api doc for 1.4.0 and 1.5.0 * add no-index flags * finish api doc archive * fix: Set ProcessingStep upload locations deterministically to avoid c… (aws#2790) * fix: Prevent repack_model script from referencing nonexistent directories (aws#2755) Co-authored-by: Payton Staub <pstaub@amazon.com> Co-authored-by: Ahsan Khan <ahsan.al.zaki@gmail.com> * fix: S3Input - add support for instance attributes (aws#2754) * fix: typos and broken link (aws#2765) Co-authored-by: Shreya Pandit <shreya.pandit25@gmail.com> * add all api docs * add appendix, fix links * structural changes, fix links * incorporate feedback * prepare release v2.72.1 * update development version to v2.72.2.dev0 Co-authored-by: Payton Staub <staubhpa@gmail.com> Co-authored-by: Payton Staub <pstaub@amazon.com> Co-authored-by: Ahsan Khan <ahsan.al.zaki@gmail.com> Co-authored-by: Mufaddal Rohawala <89424143+mufaddal-rohawala@users.noreply.github.com> Co-authored-by: Mohamed Ali Jamaoui <m.ali.jamaoui@gmail.com> Co-authored-by: Shreya Pandit <shreya.pandit25@gmail.com> Co-authored-by: ci <ci> Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com>

…s#2815)

Co-authored-by: Basil Beirouti <beirb@amazon.com> Co-authored-by: Payton Staub <pstaub@amazon.com> Co-authored-by: Ahsan Khan <ahsan.al.zaki@gmail.com> Co-authored-by: Mufaddal Rohawala <89424143+mufaddal-rohawala@users.noreply.github.com> Co-authored-by: Basil Beirouti <BasilBeirouti@gmail.com> Co-authored-by: Payton Staub <staubhpa@gmail.com> Co-authored-by: Shreya Pandit <shreya.pandit25@gmail.com> Co-authored-by: Mohamed Ali Jamaoui <m.ali.jamaoui@gmail.com> Co-authored-by: ci <ci> Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com> Co-authored-by: sreedes <70613743+sreedes@users.noreply.github.com> Co-authored-by: Navin Soni <navinns@amazon.com> Co-authored-by: Miyoung <myoung8739@gmail.com> Co-authored-by: Ameen Khan <ameenmk@amazon.com> Co-authored-by: Zhankui Lu <zhankuil@amazon.com> Co-authored-by: Xiaoguang Chen <68292680+xgchena@users.noreply.github.com> Co-authored-by: Jonathan Guinegagne <12092593+JGuinegagne@users.noreply.github.com> Co-authored-by: Zhankui Lu <zhankuilv@gmail.com> Co-authored-by: Yifei Zhu <66866419+yzhu0@users.noreply.github.com> Co-authored-by: Qingzi-Lan <83724147+Qingzi-Lan@users.noreply.github.com>

…ion for lambda step (aws#2824)

Co-authored-by: Ahsan Khan <ahsan.al.zaki@gmail.com>

Co-authored-by: Payton Staub <pstaub@amazon.com> Co-authored-by: Ahsan Khan <ahsan.al.zaki@gmail.com> Co-authored-by: Shreya Pandit <shreya.pandit25@gmail.com> Co-authored-by: Basil Beirouti <beirb@amazon.com> Co-authored-by: Mufaddal Rohawala <89424143+mufaddal-rohawala@users.noreply.github.com> Co-authored-by: Basil Beirouti <BasilBeirouti@gmail.com> Co-authored-by: Payton Staub <staubhpa@gmail.com> Co-authored-by: Mohamed Ali Jamaoui <m.ali.jamaoui@gmail.com> Co-authored-by: ci <ci> Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com> Co-authored-by: sreedes <70613743+sreedes@users.noreply.github.com> Co-authored-by: Navin Soni <navinns@amazon.com> Co-authored-by: Miyoung <myoung8739@gmail.com> Co-authored-by: Ameen Khan <ameenmk@amazon.com> Co-authored-by: Zhankui Lu <zhankuil@amazon.com> Co-authored-by: Navin Soni <navinsoni89@gmail.com> Co-authored-by: Xiaoguang Chen <68292680+xgchena@users.noreply.github.com> Co-authored-by: Jonathan Guinegagne <12092593+JGuinegagne@users.noreply.github.com> Co-authored-by: Zhankui Lu <zhankuilv@gmail.com> Co-authored-by: Yifei Zhu <66866419+yzhu0@users.noreply.github.com> Co-authored-by: Qingzi-Lan <83724147+Qingzi-Lan@users.noreply.github.com>

sagemaker-bot · 2022-02-03T22:18:54Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:19:42Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:29:39Z

AWS CodeBuild CI Report

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

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

codecov-commenter · 2022-02-03T22:32:50Z

Codecov Report

Merging #2893 (172c68f) into dev (7203862) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##              dev    #2893   +/-   ##
=======================================
  Coverage   89.49%   89.49%           
=======================================
  Files         195      195           
  Lines       16636    16636           
=======================================
  Hits        14888    14888           
  Misses       1748     1748

Impacted Files	Coverage Δ
src/sagemaker/environment_variables.py	`90.90% <ø> (ø)`
src/sagemaker/estimator.py	`91.32% <ø> (ø)`
src/sagemaker/hyperparameters.py	`84.21% <ø> (ø)`
src/sagemaker/image_uris.py	`98.80% <ø> (ø)`
src/sagemaker/model.py	`90.85% <ø> (ø)`
src/sagemaker/model_uris.py	`90.90% <100.00%> (ø)`
src/sagemaker/script_uris.py	`90.00% <100.00%> (ø)`

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 7203862...172c68f. Read the comment docs.

sagemaker-bot · 2022-02-03T22:37:35Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:37:37Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:37:37Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:38:24Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:39:39Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:43:37Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:44:09Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:45:14Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:45:15Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:54:03Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:54:03Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:54:03Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:54:03Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:56:30Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:56:31Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T22:56:31Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T23:27:45Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T23:27:45Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T23:27:46Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2022-02-03T23:27:46Z

AWS CodeBuild CI Report

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

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

Co-authored-by: Mufaddal Rohawala <muffi179@gmail.com> Co-authored-by: Basil Beirouti <beirb@amazon.com> Co-authored-by: Payton Staub <pstaub@amazon.com> Co-authored-by: Ahsan Khan <ahsan.al.zaki@gmail.com> Co-authored-by: Shreya Pandit <shreya.pandit25@gmail.com> Co-authored-by: Mufaddal Rohawala <89424143+mufaddal-rohawala@users.noreply.github.com> Co-authored-by: Basil Beirouti <BasilBeirouti@gmail.com> Co-authored-by: Payton Staub <staubhpa@gmail.com> Co-authored-by: Mohamed Ali Jamaoui <m.ali.jamaoui@gmail.com> Co-authored-by: ci <ci> Co-authored-by: Jeniya Tabassum <jeniya.tabassum@gmail.com> Co-authored-by: sreedes <70613743+sreedes@users.noreply.github.com> Co-authored-by: Navin Soni <navinns@amazon.com> Co-authored-by: Miyoung <myoung8739@gmail.com> Co-authored-by: Ameen Khan <ameenmk@amazon.com> Co-authored-by: Zhankui Lu <zhankuil@amazon.com> Co-authored-by: Xiaoguang Chen <68292680+xgchena@users.noreply.github.com> Co-authored-by: Jonathan Guinegagne <12092593+JGuinegagne@users.noreply.github.com> Co-authored-by: Zhankui Lu <zhankuilv@gmail.com> Co-authored-by: Yifei Zhu <66866419+yzhu0@users.noreply.github.com> Co-authored-by: Qingzi-Lan <83724147+Qingzi-Lan@users.noreply.github.com> Co-authored-by: Navin Soni <navinsoni89@gmail.com> Co-authored-by: Xinghan Chen <47259301+xchen909@users.noreply.github.com> Co-authored-by: Ivy Bazan <nbbazan@amazon.com> Co-authored-by: IvyBazan <45951687+IvyBazan@users.noreply.github.com>

evakravi and others added 30 commits December 6, 2021 16:54

feature: client cache for jumpstart models

b09793a

Co-authored-by: Mufaddal Rohawala <muffi179@gmail.com>

feature: allow conditional parellel builds (aws#2727)

1da6b98

fix endpoint bug (aws#2772)

1489363

Co-authored-by: Basil Beirouti <beirb@amazon.com>

fix: local mode - support relative file structure (aws#2768)

ba55962

prepare release v2.72.0

221411c

update development version to v2.72.1.dev0

395bc24

fix: Set ProcessingStep upload locations deterministically to avoid c… (

b689689

aws#2790)

fix: Prevent repack_model script from referencing nonexistent directo…

5cd25f3

…ries (aws#2755) Co-authored-by: Payton Staub <pstaub@amazon.com> Co-authored-by: Ahsan Khan <ahsan.al.zaki@gmail.com>

fix: S3Input - add support for instance attributes (aws#2754)

2e8710d

fix: typos and broken link (aws#2765)

05478a0

Co-authored-by: Shreya Pandit <shreya.pandit25@gmail.com>

prepare release v2.72.1

7da8254

update development version to v2.72.2.dev0

51404ba

fix: Add ContentType in test_auto_ml_describe

7def439

fix: Re-deploy static integ test endpoint if it is not found

cd870ec

fix: fix kmeans test deletion sequence, increment lineage statics (aw…

9ebfaf1

…s#2815)

fix: Increment static lineage pipeline (aws#2817)

071228a

fix: Update CHANGELOG.md (aws#2832)

d36d9aa

prepare release v2.72.2

02e0b15

update development version to v2.72.3.dev0

ee247c0

prepare release v2.72.3

3d491ac

update development version to v2.72.4.dev0

068ad64

fix: fixes unnecessary session call while generating pipeline definit…

3859a94

…ion for lambda step (aws#2824)

feature: Add models_v2 under lineage context (aws#2800)

77bf04f

feature: enable python 3.9 (aws#2802)

5da5364

Co-authored-by: Ahsan Khan <ahsan.al.zaki@gmail.com>

change: Update CHANGELOG.md (aws#2842)

b105b19

feature: Adding Jumpstart retrieval functions (aws#2789)

b691d3d

mufaddal-rohawala approved these changes Feb 4, 2022

View reviewed changes

shreyapandit approved these changes Feb 4, 2022

View reviewed changes

shreyapandit changed the title ~~[doc]edited doc strings and added new sections~~ documentation: Jumpstart doc strings and added new sections Feb 4, 2022

shreyapandit merged commit 4fd04f1 into aws:dev Feb 4, 2022

documentation: Jumpstart doc strings and added new sections #2893

documentation: Jumpstart doc strings and added new sections #2893

Uh oh!

Conversation

evakravi commented Feb 3, 2022

Merge Checklist

General

Tests

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Feb 3, 2022

codecov-commenter commented Feb 3, 2022 •

edited

Loading