feat: support creating endpoints with model images from private registries #1834

chiui0x18 · 2020-08-14T22:30:20Z

Issue #, if available:

Description of changes:
Allow ImageConfig to be passed as a parameter when creating endpoints.

Reference:

Testing done:

Unit tests
Create SageMaker endpoint using model image from private registry with SageMaker Python SDK and verified creation succeeded

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.

…tries

sagemaker-bot · 2020-08-14T22:32:24Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-14T22:38:46Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-14T22:55:48Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-14T23:10:04Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-17T20:09:49Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-17T20:33:01Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-17T20:49:17Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-17T21:20:07Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-17T23:47:48Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-18T00:06:13Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-18T00:08:33Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-18T00:20:04Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-18T00:54:15Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-18T01:14:42Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-18T01:26:17Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-18T01:28:15Z

AWS CodeBuild CI Report

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

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

metrizable

Thanks for the submission! There are some general meta-comments re: the ImageConfig class. The ideas warrant consideration in the future (say, v3) to provide a consistent, clean experience across the code base for Python SDK users. Ultimately, it's clear the RepositoryAccessMode should be available.

metrizable · 2020-08-18T15:48:23Z

src/sagemaker/image_config.py

+from __future__ import absolute_import
+
+
+class ImageConfig(object):


remove the (object) as unneeded

metrizable · 2020-08-18T15:56:48Z

src/sagemaker/model.py

+            image_config (sagemaker.ImageConfig): Specifies whether the image of
+                model container is pulled from ECR, or private registry in your
+                VPC. By default it is set to pull model container image from
+                ECR. (default: None).


the behavior of this argument is different than other arguments of this class, such as env and vpc_config. is the ImageConfig class needed?

metrizable · 2020-08-18T15:59:48Z

src/sagemaker/image_config.py

+
+
+class ImageConfig(object):
+    """Configuration of Docker image used in Model."""


is this class needed? it's not clear what value it is providing. it's essentially a dict with a single key and default value. this paradigm is also inconsistent with the behavior of other arguments of container_def.

is this class needed? it's not clear what value it is providing. it's essentially a dict with a single key and default value.

The initial idea of using such class is to retain enough flexibility as more features for private registry support are added in the future. Thinking twice, this seems an overkill as ImageConfig has already positioned itself as a configuration bag, so I think a plain dict[str, object] shall suffice.

metrizable · 2020-08-18T16:00:58Z

src/sagemaker/image_config.py

+        req = {
+            "RepositoryAccessMode": "Platform",
+        }


this generates a new dict every time the method is invoked. is that desired?

metrizable · 2020-08-18T16:02:32Z

src/sagemaker/model.py

+        image_config_dict = None
+        if self.image_config:
+            image_config_dict = self.image_config._to_request_dict()


the encapsulating class ImageConfig leads to extra code

sagemaker-bot · 2020-08-26T16:21:38Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-26T16:45:39Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-26T17:01:00Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-26T17:12:42Z

AWS CodeBuild CI Report

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

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

`ImageConfig` class is overkill to model a configuration bag.

sagemaker-bot · 2020-08-26T19:12:14Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-26T19:34:41Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-08-26T19:43:18Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-10-13T19:02:13Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-11-18T21:37:58Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-11-18T22:00:48Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-11-18T22:06:36Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-11-18T22:15:21Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-11-18T23:06:14Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-12-09T19:20:34Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-12-09T19:51:46Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-12-09T19:55:09Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2020-12-09T21:05:17Z

AWS CodeBuild CI Report

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

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

icywang86rui · 2021-01-07T21:53:17Z

please resolve the conflict

icywang86rui · 2021-01-12T00:27:52Z

Please resolve the conflicts.

sagemaker-bot · 2021-03-03T03:40:21Z

AWS CodeBuild CI Report

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

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

ChoiByungWook

Awesome!!!

I resolved the merge conflict and also submitted a few commits to address pylint issues.

sagemaker-bot · 2021-03-03T04:01:30Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2021-03-03T04:30:22Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2021-03-03T04:30:43Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2021-03-03T04:36:13Z

AWS CodeBuild CI Report

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

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

sagemaker-bot · 2021-03-03T04:40:42Z

AWS CodeBuild CI Report

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

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

feat: support creating endpoints with model images from private regis…

4b8cb29

…tries

Merge branch 'master' into hosting-private-registry-support

763a194

fix: fix pylint and flake8 errors

dcea509

Merge branch 'master' into hosting-private-registry-support

dc728e0

metrizable reviewed Aug 18, 2020

View reviewed changes

Merge branch 'master' into hosting-private-registry-support

da74035

change: simplify modeling of ImageConfig

17b14f8

`ImageConfig` class is overkill to model a configuration bag.

Merge branch 'master' into hosting-private-registry-support

8f7fdb1

icywang86rui previously approved these changes Nov 18, 2020

View reviewed changes

Merge branch 'master' into hosting-private-registry-support

0b1670e

ChoiByungWook added the pending: merge conflicts label Feb 25, 2021

Dan and others added 2 commits March 2, 2021 19:23

Merge branch 'master' into hosting-private-registry-support

446de53

add newline in between return and input doc

84f073e

ChoiByungWook dismissed icywang86rui’s stale review via 84f073e March 3, 2021 03:35

split long doc string to newline

3e17050

ChoiByungWook removed the pending: merge conflicts label Mar 3, 2021

ChoiByungWook approved these changes Mar 3, 2021

View reviewed changes

ChoiByungWook changed the title ~~feat: support creating endpoints with model images from private regis…~~ feat: support creating endpoints with model images from private registries Mar 3, 2021

ChoiByungWook merged commit 630b51c into aws:master Mar 3, 2021

		from __future__ import absolute_import


		class ImageConfig(object):



		class ImageConfig(object):
		"""Configuration of Docker image used in Model."""

feat: support creating endpoints with model images from private registries #1834

feat: support creating endpoints with model images from private registries #1834

Uh oh!

Conversation

chiui0x18 commented Aug 14, 2020 • edited by ChoiByungWook 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 14, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 14, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 14, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 14, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 17, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 17, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 17, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 17, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 17, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Aug 18, 2020

AWS CodeBuild CI Report

Uh oh!

metrizable left a comment

Choose a reason for hiding this comment

Uh oh!

metrizable Aug 18, 2020

Choose a reason for hiding this comment

Uh oh!

metrizable Aug 18, 2020

Choose a reason for hiding this comment

Uh oh!

metrizable Aug 18, 2020

Choose a reason for hiding this comment

Uh oh!

chiui0x18 Aug 26, 2020

Choose a reason for hiding this comment

Uh oh!

metrizable Aug 18, 2020

Choose a reason for hiding this comment

Uh oh!

metrizable Aug 18, 2020

Choose a reason for hiding this comment

Uh oh!

sagemaker-bot commented Aug 26, 2020

chiui0x18 commented Aug 14, 2020 •

edited by ChoiByungWook

Loading