doc: Add ECR URI Estimator example #1688

IvyBazan · 2020-07-08T23:00:11Z

Added example of creating an Estimator using an ECR URI

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 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 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.

Added example of creating an Estimator using an ECR URI

sagemaker-bot · 2020-07-08T23:01:25Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-08T23:01:31Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-08T23:02:43Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-08T23:05:38Z

AWS CodeBuild CI Report

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

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

laurenyu · 2020-07-08T23:13:36Z

doc/frameworks/tensorflow/using_tf.rst

@@ -197,6 +197,26 @@ The following args are not permitted when using Script Mode:
 Where the S3 url is a path to your training data within Amazon S3.
 The constructor keyword arguments define how SageMaker runs your training script.

+Create an Estimator using Docker containers


I think this sounds a bit misleading - the estimator isn't being created by way of somehow running a Docker container - this is just describing how to specify a custom Docker image with an estimator.

Also, what's the motivation for putting this in the TF doc as opposed to a more general section? The information included in this change is more broad than TF.

sagemaker-bot · 2020-07-08T23:29:19Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-08T23:30:00Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-08T23:30:05Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-08T23:32:54Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-08T23:34:37Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-08T23:34:41Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-08T23:35:02Z

AWS CodeBuild CI Report

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

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

removed trailing whitespace

sagemaker-bot · 2020-07-08T23:36:38Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-08T23:36:38Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-08T23:36:59Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-08T23:38:28Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-08T23:46:08Z

AWS CodeBuild CI Report

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

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

doc/frameworks/tensorflow/using_tf.rst

laurenyu · 2020-07-09T16:04:00Z

doc/frameworks/tensorflow/using_tf.rst

+Specify a Docker image using an Estimator
+-----------------------------------------
+
+You can also specify a Docker image when creating an Estimator by specifying the ECR URI for the Python and framework version directly. For a full list of available container URIs, see `Available Deep Learning Containers Images <https://github.com/aws/deep-learning-containers/blob/master/available_images.md>`__ For more information on using Docker containers, see `Use Your Own Algorithms or Models with Amazon SageMaker <https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html>`__.


Suggested change

You can also specify a Docker image when creating an Estimator by specifying the ECR URI for the Python and framework version directly. For a full list of available container URIs, see `Available Deep Learning Containers Images <https://github.com/aws/deep-learning-containers/blob/master/available_images.md>`__ For more information on using Docker containers, see `Use Your Own Algorithms or Models with Amazon SageMaker <https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html>`__.

You can also specify a Docker image when creating an Estimator by directly specifying the ECR URI instead of the Python and framework version. For a full list of available container URIs, see `Available Deep Learning Containers Images <https://github.com/aws/deep-learning-containers/blob/master/available_images.md>`__ For more information on using Docker containers, see `Use Your Own Algorithms or Models with Amazon SageMaker <https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html>`__.

laurenyu · 2020-07-09T16:06:52Z

doc/frameworks/tensorflow/using_tf.rst

+Specify a Docker image using an Estimator
+-----------------------------------------
+
+You can also specify a Docker image when creating an Estimator by specifying the ECR URI for the Python and framework version directly. For a full list of available container URIs, see `Available Deep Learning Containers Images <https://github.com/aws/deep-learning-containers/blob/master/available_images.md>`__ For more information on using Docker containers, see `Use Your Own Algorithms or Models with Amazon SageMaker <https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html>`__.


Half of the use cases in Use Your Own Algorithms or Models with Amazon SageMaker (the first two) don't require the user to have to do anything themselves with Docker. Docker Container Basics seems like it's probably more about using Docker containers?

I'm restructuring those docs to make them more explicitly about Docker containers.

doc/frameworks/tensorflow/using_tf.rst

laurenyu · 2020-07-09T16:10:34Z

doc/frameworks/tensorflow/using_tf.rst

+- ``py_version=''``
+- ``framework_version=''``
+
+The following example uses the ``image_name='763104351884.dkr.ecr.us-east-1.amazonaws.com/tensorflow-training:1.15.2-cpu-py37-ubuntu18.04'`` arg to specify the container image, Python version, and framework version:


I think it would be better to put an obviously fake placeholder image URI and direct to the doc page with the updated URIs. While the example URI is the latest TF 1.x version right now, it's less likely that this will get updated as future versions of TF are released.

doc/frameworks/tensorflow/using_tf.rst

sagemaker-bot · 2020-07-20T17:43:42Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-20T17:43:45Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-20T17:43:46Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-20T17:52:52Z

AWS CodeBuild CI Report

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

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

Added review changes

IvyBazan · 2020-07-20T23:24:55Z

@laurenyu Made fixed to address your feedback

sagemaker-bot · 2020-07-20T23:25:14Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-20T23:25:28Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-20T23:25:55Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-20T23:26:32Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-20T23:27:59Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-20T23:34:45Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-20T23:34:45Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-21T21:16:52Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-21T21:16:53Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-21T21:17:15Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-21T21:26:27Z

AWS CodeBuild CI Report

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

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

laurenyu

just one small comment for lining up the args. I assume similar changes for inference and other frameworks will come in separate PRs?

doc/frameworks/tensorflow/using_tf.rst

Co-authored-by: Lauren Yu <[email protected]>

sagemaker-bot · 2020-07-21T22:29:21Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-21T22:29:25Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-21T22:29:34Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-21T22:38:56Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-07-21T23:35:19Z

AWS CodeBuild CI Report

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

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

Update using_tf.rst

6a374a6

Added example of creating an Estimator using an ECR URI

laurenyu changed the title ~~[docs] Added ECR URI Estimator example~~ doc: ADd ECR URI Estimator example Jul 8, 2020

laurenyu suggested changes Jul 8, 2020

View reviewed changes

Update using_tf.rst

cc63778

Update using_tf.rst

30f4f24

Update using_tf.rst

a4adceb

removed trailing whitespace

laurenyu changed the title ~~doc: ADd ECR URI Estimator example~~ doc: Add ECR URI Estimator example Jul 8, 2020

laurenyu reviewed Jul 9, 2020

View reviewed changes

Merge branch 'master' into master

31c3ce9

Update using_tf.rst

fe829d8

Added review changes

Merge branch 'master' into master

54e4343

Merge branch 'master' into master

15c8f3a

laurenyu reviewed Jul 21, 2020

View reviewed changes

doc/frameworks/tensorflow/using_tf.rst Outdated Show resolved Hide resolved

Update doc/frameworks/tensorflow/using_tf.rst

6cbf3d7

Co-authored-by: Lauren Yu <[email protected]>

laurenyu approved these changes Jul 21, 2020

View reviewed changes

laurenyu merged commit 6cdc977 into aws:master Jul 21, 2020

doc: Add ECR URI Estimator example #1688

doc: Add ECR URI Estimator example #1688

Uh oh!

Conversation

IvyBazan commented Jul 8, 2020 • edited by laurenyu Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge Checklist

General

Tests

Uh oh!

sagemaker-bot commented Jul 8, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Jul 8, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Jul 8, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Jul 8, 2020

AWS CodeBuild CI Report

Uh oh!

laurenyu Jul 8, 2020

Choose a reason for hiding this comment

Uh oh!

sagemaker-bot commented Jul 8, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Jul 8, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Jul 8, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Jul 8, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Jul 8, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Jul 8, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Jul 8, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Jul 8, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Jul 8, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Jul 8, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Jul 8, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Jul 8, 2020

AWS CodeBuild CI Report

Uh oh!

Uh oh!

laurenyu Jul 9, 2020

Choose a reason for hiding this comment

Uh oh!

IvyBazan Jul 20, 2020

Choose a reason for hiding this comment

Uh oh!

laurenyu Jul 9, 2020

Choose a reason for hiding this comment

Uh oh!

IvyBazan Jul 20, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

laurenyu Jul 9, 2020

Choose a reason for hiding this comment

Uh oh!

IvyBazan Jul 20, 2020

Choose a reason for hiding this comment

IvyBazan commented Jul 8, 2020 •

edited by laurenyu

Loading