Skip to content

change: use image_uris.retrieve() for ModelMonitor default image #1765

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions src/sagemaker/image_uri_config/model-monitor.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"scope": ["monitoring"],
"versions": {
"": {
"registries": {
"eu-north-1": "895015795356",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpicky nitpick: alphabetize the regions

"me-south-1": "607024016150",
"ap-south-1": "126357580389",
"us-east-2": "777275614652",
"eu-west-1": "468650794304",
"eu-central-1": "048819808253",
"sa-east-1": "539772159869",
"ap-east-1": "001633400207",
"us-east-1": "156813124566",
"ap-northeast-2": "709848358524",
"eu-west-2": "749857270468",
"eu-west-3": "680080141114",
"ap-northeast-1": "574779866223",
"us-west-2": "159807026194",
"us-west-1": "890145073186",
"ap-southeast-1": "245545462676",
"ap-southeast-2": "563025443158",
"ca-central-1": "536280801234",
"cn-north-1": "453000072557",
"cn-northwest-1": "453252182341"
},
"repository": "sagemaker-model-monitor-analyzer"
}
}
}
9 changes: 6 additions & 3 deletions src/sagemaker/image_uris.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

logger = logging.getLogger(__name__)

ECR_URI_TEMPLATE = "{registry}.dkr.{hostname}/{repository}:{tag}"
ECR_URI_TEMPLATE = "{registry}.dkr.{hostname}/{repository}"


def retrieve(
Expand Down Expand Up @@ -69,14 +69,17 @@ def retrieve(
registry = _registry_from_region(region, version_config["registries"])
hostname = utils._botocore_resolver().construct_endpoint("ecr", region)["hostname"]

repo = version_config["repository"]

processor = _processor(
instance_type, config.get("processors") or version_config.get("processors")
)
tag = _format_tag(version_config.get("tag_prefix", version), processor, py_version)

repo = version_config["repository"]
if tag:
repo += ":{}".format(tag)

return ECR_URI_TEMPLATE.format(registry=registry, hostname=hostname, repository=repo, tag=tag)
return ECR_URI_TEMPLATE.format(registry=registry, hostname=hostname, repository=repo)


def _config_for_framework_and_scope(framework, image_scope, accelerator_type=None):
Expand Down
36 changes: 7 additions & 29 deletions src/sagemaker/model_monitor/model_monitoring.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,38 +26,16 @@
from six.moves.urllib.parse import urlparse
from botocore.exceptions import ClientError

from sagemaker import image_uris
from sagemaker.exceptions import UnexpectedStatusException
from sagemaker.model_monitor.monitoring_files import Constraints, ConstraintViolations, Statistics
from sagemaker.network import NetworkConfig
from sagemaker.processing import Processor, ProcessingInput, ProcessingJob, ProcessingOutput
from sagemaker.s3 import S3Uploader
from sagemaker.session import Session
from sagemaker.utils import name_from_base, retries, get_ecr_image_uri_prefix

_DEFAULT_MONITOR_IMAGE_URI_WITH_PLACEHOLDERS = "{}/sagemaker-model-monitor-analyzer"

_DEFAULT_MONITOR_IMAGE_REGION_ACCOUNT_MAPPING = {
"eu-north-1": "895015795356",
"me-south-1": "607024016150",
"ap-south-1": "126357580389",
"us-east-2": "777275614652",
"eu-west-1": "468650794304",
"eu-central-1": "048819808253",
"sa-east-1": "539772159869",
"ap-east-1": "001633400207",
"us-east-1": "156813124566",
"ap-northeast-2": "709848358524",
"eu-west-2": "749857270468",
"eu-west-3": "680080141114",
"ap-northeast-1": "574779866223",
"us-west-2": "159807026194",
"us-west-1": "890145073186",
"ap-southeast-1": "245545462676",
"ap-southeast-2": "563025443158",
"ca-central-1": "536280801234",
"cn-north-1": "453000072557",
"cn-northwest-1": "453252182341",
}
from sagemaker.utils import name_from_base, retries

DEFAULT_REPOSITORY_NAME = "sagemaker-model-monitor-analyzer"

STATISTICS_JSON_DEFAULT_FILE_NAME = "statistics.json"
CONSTRAINTS_JSON_DEFAULT_FILE_NAME = "constraints.json"
Expand Down Expand Up @@ -89,6 +67,8 @@

_LOGGER = logging.getLogger(__name__)

framework_name = "model-monitor"


class ModelMonitor(object):
"""Sets up Amazon SageMaker Monitoring Schedules and baseline suggestions. Use this class when
Expand Down Expand Up @@ -1787,9 +1767,7 @@ def _get_default_image_uri(region):
Returns:
str: The Default Model Monitoring image uri based on the region.
"""
return _DEFAULT_MONITOR_IMAGE_URI_WITH_PLACEHOLDERS.format(
get_ecr_image_uri_prefix(_DEFAULT_MONITOR_IMAGE_REGION_ACCOUNT_MAPPING[region], region)
)
return image_uris.retrieve(framework=framework_name, region=region)


class BaseliningJob(ProcessingJob):
Expand Down
7 changes: 2 additions & 5 deletions src/sagemaker/predictor.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
from sagemaker.utils import name_from_base

from sagemaker.model_monitor.model_monitoring import (
_DEFAULT_MONITOR_IMAGE_URI_WITH_PLACEHOLDERS,
DEFAULT_REPOSITORY_NAME,
ModelMonitor,
DefaultModelMonitor,
)
Expand Down Expand Up @@ -357,10 +357,7 @@ def list_monitors(self):
image_uri = schedule["MonitoringScheduleConfig"]["MonitoringJobDefinition"][
"MonitoringAppSpecification"
]["ImageUri"]
index_after_placeholders = _DEFAULT_MONITOR_IMAGE_URI_WITH_PLACEHOLDERS.rfind("{}")
if image_uri.endswith(
_DEFAULT_MONITOR_IMAGE_URI_WITH_PLACEHOLDERS[index_after_placeholders + len("{}") :]
):
if image_uri.endswith(DEFAULT_REPOSITORY_NAME):
monitors.append(
DefaultModelMonitor.attach(
monitor_schedule_name=schedule_name,
Expand Down
6 changes: 6 additions & 0 deletions tests/unit/sagemaker/image_uris/expected_uris.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
}
DOMAIN = "amazonaws.com"
IMAGE_URI_FORMAT = "{}.dkr.ecr.{}.{}/{}:{}"
MONITOR_URI_FORMAT = "{}.dkr.ecr.{}.{}/sagemaker-model-monitor-analyzer"
REGION = "us-west-2"


Expand All @@ -34,3 +35,8 @@ def framework_uri(repo, fw_version, account, py_version=None, processor="cpu", r
def algo_uri(algo, account, region, version=1):
domain = ALTERNATE_DOMAINS.get(region, DOMAIN)
return IMAGE_URI_FORMAT.format(account, region, domain, algo, version)


def monitor_uri(account, region=REGION):
domain = ALTERNATE_DOMAINS.get(region, DOMAIN)
return MONITOR_URI_FORMAT.format(account, region, domain)
48 changes: 48 additions & 0 deletions tests/unit/sagemaker/image_uris/test_model_monitor.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
from __future__ import absolute_import

from sagemaker import image_uris
from tests.unit.sagemaker.image_uris import expected_uris, regions

ACCOUNTS = {
"eu-north-1": "895015795356",
"me-south-1": "607024016150",
"ap-south-1": "126357580389",
"us-east-2": "777275614652",
"eu-west-1": "468650794304",
"eu-central-1": "048819808253",
"sa-east-1": "539772159869",
"ap-east-1": "001633400207",
"us-east-1": "156813124566",
"ap-northeast-2": "709848358524",
"eu-west-2": "749857270468",
"eu-west-3": "680080141114",
"ap-northeast-1": "574779866223",
"us-west-2": "159807026194",
"us-west-1": "890145073186",
"ap-southeast-1": "245545462676",
"ap-southeast-2": "563025443158",
"ca-central-1": "536280801234",
"cn-north-1": "453000072557",
"cn-northwest-1": "453252182341",
}


def test_model_monitor():
for region in regions.regions():
if region in ACCOUNTS.keys():
uri = image_uris.retrieve("model-monitor", region=region)

expected = expected_uris.monitor_uri(ACCOUNTS[region], region)
assert expected == uri
2 changes: 2 additions & 0 deletions tests/unit/sagemaker/monitor/test_model_monitoring.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@


CUSTOM_IMAGE_URI = "012345678901.dkr.ecr.us-west-2.amazonaws.com/my-custom-image-uri"
DEFAULT_IMAGE_URI = "159807026194.dkr.ecr.us-west-2.amazonaws.com/sagemaker-model-monitor-analyzer"

INTER_CONTAINER_ENCRYPTION_EXCEPTION_MSG = (
"EnableInterContainerTrafficEncryption is not supported in Model Monitor. Please ensure that "
Expand Down Expand Up @@ -126,6 +127,7 @@ def test_default_model_monitor_suggest_baseline(sagemaker_session):
assert my_default_monitor.sagemaker_session == sagemaker_session
assert my_default_monitor.tags == TAGS
assert my_default_monitor.network_config == NETWORK_CONFIG
assert my_default_monitor.image_uri == DEFAULT_IMAGE_URI

assert BASE_JOB_NAME in my_default_monitor.latest_baselining_job_name
assert my_default_monitor.latest_baselining_job_name != BASE_JOB_NAME
Expand Down