doc: JumpStart Utility Doc Update #3866

judyheflin · 2023-05-17T20:04:51Z

Description of changes: Added documentation for low-code JumpStart model deployment and fine-tuning. Included JumpStartModel, JumpStartEstimator, and utility APIs in the docs.

Testing done: Staged on local build successfully and passed tox checks.

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
[ x] I certify that the changes I am introducing will be backward compatible, and I have discussed concerns about this, if any, with the Python SDK team
[ x] I used the commit message format described in CONTRIBUTING
[ x] I have passed the region in to all S3 and STS clients that I've initialized as part of this change.
[ x] I have updated any necessary documentation, including READMEs and API docs (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 · 2023-05-17T20:17:58Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-17T20:48:21Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-17T20:56:49Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-17T21:00:53Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-17T21:21:58Z

AWS CodeBuild CI Report

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

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

knikure · 2023-05-18T00:06:07Z

@judyheflin Can you fix these doc8 errors:

/codebuild/output/src248763720/src/github.com/aws/sagemaker-python-sdk/doc/overview.rst:588: D002 Trailing whitespace
/codebuild/output/src248763720/src/github.com/aws/sagemaker-python-sdk/doc/overview.rst:648: D002 Trailing whitespace
/codebuild/output/src248763720/src/github.com/aws/sagemaker-python-sdk/doc/overview.rst:733: D002 Trailing whitespace
/codebuild/output/src248763720/src/github.com/aws/sagemaker-python-sdk/doc/overview.rst:734: D002 Trailing whitespace
/codebuild/output/src248763720/src/github.com/aws/sagemaker-python-sdk/doc/overview.rst:744: D002 Trailing whitespace
/codebuild/output/src248763720/src/github.com/aws/sagemaker-python-sdk/doc/overview.rst:752: D002 Trailing whitespace
/codebuild/output/src248763720/src/github.com/aws/sagemaker-python-sdk/doc/api/training/estimators.rst:24: D005 No newline at end of file

Finally submit your changes after successfully running ./.githooks/pre-push command.

judyheflin · 2023-05-18T00:45:52Z

@judyheflin Can you fix these doc8 errors:

/codebuild/output/src248763720/src/github.com/aws/sagemaker-python-sdk/doc/overview.rst:588: D002 Trailing whitespace
/codebuild/output/src248763720/src/github.com/aws/sagemaker-python-sdk/doc/overview.rst:648: D002 Trailing whitespace
/codebuild/output/src248763720/src/github.com/aws/sagemaker-python-sdk/doc/overview.rst:733: D002 Trailing whitespace
/codebuild/output/src248763720/src/github.com/aws/sagemaker-python-sdk/doc/overview.rst:734: D002 Trailing whitespace
/codebuild/output/src248763720/src/github.com/aws/sagemaker-python-sdk/doc/overview.rst:744: D002 Trailing whitespace
/codebuild/output/src248763720/src/github.com/aws/sagemaker-python-sdk/doc/overview.rst:752: D002 Trailing whitespace
/codebuild/output/src248763720/src/github.com/aws/sagemaker-python-sdk/doc/api/training/estimators.rst:24: D005 No newline at end of file

Finally submit your changes after successfully running ./.githooks/pre-push command.

Yes will do -- this PR is still a WIP.

JGuinegagne · 2023-05-18T12:19:35Z

doc/overview.rst

@@ -725,7 +724,35 @@ retrieve the related image as follows.
       instance_type="ml.m5.xlarge",
   )

-Deploy a  Pre-Trained Model Directly to a SageMaker Endpoint
+Low-code Deployment
+===================


How about moving Low-code Deployment section before built-in Components section?

That way, users would don't want to dive deeper into the underlying mechanics can stop reading after the Low-code Deployment section and try it out.

Restructured the order based on this feedback

sagemaker-bot · 2023-05-26T15:00:22Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-26T15:36:47Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-26T16:16:51Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-26T16:24:18Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-26T16:28:16Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-26T17:19:17Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-26T18:15:00Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-26T18:54:36Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-26T19:02:55Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-26T19:06:23Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-26T19:11:39Z

AWS CodeBuild CI Report

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

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

evakravi · 2023-05-26T19:37:58Z

doc/overview.rst


 .. code:: python

-   from sagemaker import model_uris
+    question = "What is Southern California often abbreviated as?"


can we use a more generic payload, like hello world!? I don't want to set the expectation that this is the kind of payload that should be given.

Yep, can do -- will make both of these more generic

Could you check with @khetan2 please?

Since this is a generative model, I feel like we should ask it a question.

This payload was the example for another model, so I'm not sure it's appropriate here

After thinking about this more and discussing with Ashish, FLAN-T5 XL is currently our #1 recommended model for question/answering, so this example prompt is fine here. GPT-J (the other example model) can also be used for question/answering, but is more flexible for additional use cases. We can mention that GPT-J can be used for things like code generation, summarization, and more, but the q&a example will still be applicable. In general, customers can explore our documentation, the pretrained models table, and example notebooks to find appropriate use cases for each model.

evakravi · 2023-05-26T19:39:50Z

doc/overview.rst

-and https://github.com/aws/sagemaker-scikit-learn-container. Use
-the ``model_id`` and ``version`` of the corresponding model to
-retrieve the related image as follows.
+To check valid data input and output formats for inference, you can use the ``retrieve_options()`` method


can we also mention the content type and accept type utilities?

https://github.com/aws/sagemaker-python-sdk/blob/master/src/sagemaker/content_types.py

https://github.com/aws/sagemaker-python-sdk/blob/master/src/sagemaker/accept_types.py

evakravi · 2023-05-26T19:40:09Z

doc/overview.rst

+
+.. code:: python
+
+    question = "What is Southern California often abbreviated as?"


same question here about the payload

sagemaker-bot · 2023-05-26T20:06:00Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-26T20:12:53Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-26T20:15:53Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-05-26T20:30:57Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-06-01T18:03:51Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-06-01T18:48:01Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-06-01T19:10:55Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-06-01T19:15:37Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-06-01T21:00:23Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-06-01T23:46:19Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-06-01T23:48:55Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-06-02T00:08:02Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-06-02T00:12:00Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2023-06-02T01:58:06Z

AWS CodeBuild CI Report

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

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

judyheflin requested a review from a team as a code owner May 17, 2023 20:04

judyheflin requested review from knikure and removed request for a team May 17, 2023 20:04

knikure self-assigned this May 18, 2023

JGuinegagne reviewed May 18, 2023

View reviewed changes

evakravi reviewed May 26, 2023

View reviewed changes

knikure changed the title ~~JumpStart Utility Doc Update~~ doc: JumpStart Utility Doc Update Jun 1, 2023

JGuinegagne approved these changes Jun 1, 2023

View reviewed changes

Judy Heflin added 14 commits June 1, 2023 15:56

JumpStartModel documentation

ae2a0d0

Remove JS model references

a25e2a6

Fixed spacing on Python examples

1b52f02

Low-code deployment doc formatting

700ca26

Fixed JS Model docstring formatting

ae6ebdf

Fixed estimator docstring formatting

009493f

Added fine-tuning steps

39672aa

Finalized deployment text

449ab5e

Added fine-tuning utilities

37aa14b

Removed trailing whitespaces

b3e7713

Added new utilities to Utility API docs

c87210a

Finalized doc feedback and API docstring locations

3b37024

Fixed link

004ea79

Fixed newline formatting

d970f91

judyheflin force-pushed the judyheflin-jumpstart-doc-update branch from 973e8ec to d970f91 Compare June 1, 2023 22:56

evakravi approved these changes Jun 1, 2023

View reviewed changes

knikure approved these changes Jun 2, 2023

View reviewed changes

knikure merged commit b538525 into aws:master Jun 2, 2023


		.. code:: python

		question = "What is Southern California often abbreviated as?"

doc: JumpStart Utility Doc Update #3866

doc: JumpStart Utility Doc Update #3866

Conversation

judyheflin commented May 17, 2023 • edited Loading

Merge Checklist

General

sagemaker-bot commented May 17, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 17, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 17, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 17, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 17, 2023

AWS CodeBuild CI Report

knikure commented May 18, 2023

judyheflin commented May 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sagemaker-bot commented May 26, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2023

AWS CodeBuild CI Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

judyheflin May 31, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sagemaker-bot commented May 26, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2023

AWS CodeBuild CI Report

sagemaker-bot commented May 26, 2023

AWS CodeBuild CI Report

sagemaker-bot commented Jun 1, 2023

AWS CodeBuild CI Report

sagemaker-bot commented Jun 1, 2023

AWS CodeBuild CI Report

sagemaker-bot commented Jun 1, 2023

AWS CodeBuild CI Report

sagemaker-bot commented Jun 1, 2023

AWS CodeBuild CI Report

sagemaker-bot commented Jun 1, 2023

AWS CodeBuild CI Report

sagemaker-bot commented Jun 1, 2023

AWS CodeBuild CI Report

sagemaker-bot commented Jun 1, 2023

AWS CodeBuild CI Report

sagemaker-bot commented Jun 2, 2023

AWS CodeBuild CI Report

sagemaker-bot commented Jun 2, 2023

AWS CodeBuild CI Report

sagemaker-bot commented Jun 2, 2023

AWS CodeBuild CI Report

judyheflin commented May 17, 2023 •

edited

Loading

judyheflin May 31, 2023 •

edited

Loading