Skip to content

feature: Combined inference and training script artifact #3717

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 14 commits into from
Apr 4, 2023
Merged
Show file tree
Hide file tree
Changes from 5 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
13 changes: 8 additions & 5 deletions src/sagemaker/jumpstart/artifacts.py
Original file line number Diff line number Diff line change
Expand Up @@ -235,10 +235,10 @@ def _retrieve_model_uri(
def _retrieve_script_uri(
model_id: str,
model_version: str,
script_scope: Optional[str],
region: Optional[str],
tolerate_vulnerable_model: bool,
tolerate_deprecated_model: bool,
script_scope: Optional[str] = None,
region: Optional[str] = False,
tolerate_vulnerable_model: bool = False,
tolerate_deprecated_model: bool = False,
):
"""Retrieves the script S3 URI associated with the model matching the given arguments.

Expand Down Expand Up @@ -281,7 +281,10 @@ def _retrieve_script_uri(
)

if script_scope == JumpStartScriptScope.INFERENCE:
model_script_key = model_specs.hosting_script_key
model_script_key = (
getattr(model_specs, "training_prepacked_script_key") or model_specs.hosting_script_key
)
Copy link
Contributor

Choose a reason for hiding this comment

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

question: shouldn't there be a way to access the uncombined model artifact?

Could you please align with @whittech1 on this?

Copy link
Member Author

Choose a reason for hiding this comment

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

We decided that there is no harm in including the script with the model artifact, even if someone only wants the model artifact. Most of the combined tarball is the model artifact, so it doesn't make a huge difference in terms of storage

Copy link
Contributor

Choose a reason for hiding this comment

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

The risk is that there are extra files left over from the combined model artifact in the code dir when a user tries to override the script. In the worst case, it could make the new combined script crash. Maybe we should sleep on this.


elif script_scope == JumpStartScriptScope.TRAINING:
model_script_key = model_specs.training_script_key

Expand Down
4 changes: 4 additions & 0 deletions src/sagemaker/jumpstart/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,7 @@ class JumpStartModelSpecs(JumpStartDataHolderType):
"training_vulnerabilities",
"deprecated",
"metrics",
"training_prepacked_script_key",
]

def __init__(self, spec: Dict[str, Any]):
Expand Down Expand Up @@ -330,6 +331,9 @@ def from_json(self, json_obj: Dict[str, Any]) -> None:
self.training_vulnerabilities: List[str] = json_obj["training_vulnerabilities"]
self.deprecated: bool = bool(json_obj["deprecated"])
self.metrics: Optional[List[Dict[str, str]]] = json_obj.get("metrics", None)
self.training_prepacked_script_key: Optional[str] = json_obj.get(
"training_prepacked_script_key", None
)

if self.training_supported:
self.training_ecr_specs: JumpStartECRSpecs = JumpStartECRSpecs(
Expand Down
126 changes: 126 additions & 0 deletions tests/unit/sagemaker/jumpstart/constants.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,131 @@
# language governing permissions and limitations under the License.
from __future__ import absolute_import


SPECIAL_MODEL_SPECS_DICT = {
"mock-model-training-prepacked-script-key": {
"model_id": "sklearn-classification-linear",
"url": "https://scikit-learn.org/stable/",
"version": "1.0.0",
"min_sdk_version": "2.68.1",
"training_supported": True,
"incremental_training_supported": False,
"hosting_ecr_specs": {
"framework": "sklearn",
"framework_version": "0.23-1",
"py_version": "py3",
},
"hosting_artifact_key": "sklearn-infer/infer-sklearn-classification-linear.tar.gz",
"hosting_script_key": "source-directory-tarballs/sklearn/inference/classification/v1.0.0/sourcedir.tar.gz",
"inference_vulnerable": False,
"inference_dependencies": [],
"inference_vulnerabilities": [],
"training_vulnerable": False,
"training_dependencies": [],
"training_vulnerabilities": [],
"deprecated": False,
"hyperparameters": [
{
"name": "tol",
"type": "float",
"default": 0.0001,
"min": 1e-20,
"max": 50,
"scope": "algorithm",
},
{
"name": "penalty",
"type": "text",
"default": "l2",
"options": ["l1", "l2", "elasticnet", "none"],
"scope": "algorithm",
},
{
"name": "alpha",
"type": "float",
"default": 0.0001,
"min": 1e-20,
"max": 999,
"scope": "algorithm",
},
{
"name": "l1_ratio",
"type": "float",
"default": 0.15,
"min": 0,
"max": 1,
"scope": "algorithm",
},
{
"name": "sagemaker_submit_directory",
"type": "text",
"default": "/opt/ml/input/data/code/sourcedir.tar.gz",
"scope": "container",
},
{
"name": "sagemaker_program",
"type": "text",
"default": "transfer_learning.py",
"scope": "container",
},
{
"name": "sagemaker_container_log_level",
"type": "text",
"default": "20",
"scope": "container",
},
],
"training_script_key": "source-directory-tarballs/sklearn/transfer_learning/classification/"
"v1.0.0/sourcedir.tar.gz",
"training_prepacked_script_key": "some/key/to/training_prepacked_script_key.tar.gz",
"training_ecr_specs": {
"framework_version": "0.23-1",
"framework": "sklearn",
"py_version": "py3",
},
"training_artifact_key": "sklearn-training/train-sklearn-classification-linear.tar.gz",
"inference_environment_variables": [
{
"name": "SAGEMAKER_PROGRAM",
"type": "text",
"default": "inference.py",
"scope": "container",
},
{
"name": "SAGEMAKER_SUBMIT_DIRECTORY",
"type": "text",
"default": "/opt/ml/model/code",
"scope": "container",
},
{
"name": "SAGEMAKER_CONTAINER_LOG_LEVEL",
"type": "text",
"default": "20",
"scope": "container",
},
{
"name": "MODEL_CACHE_ROOT",
"type": "text",
"default": "/opt/ml/model",
"scope": "container",
},
{"name": "SAGEMAKER_ENV", "type": "text", "default": "1", "scope": "container"},
{
"name": "SAGEMAKER_MODEL_SERVER_WORKERS",
"type": "text",
"default": "1",
"scope": "container",
},
{
"name": "SAGEMAKER_MODEL_SERVER_TIMEOUT",
"type": "text",
"default": "3600",
"scope": "container",
},
],
}
}

PROTOTYPICAL_MODEL_SPECS_DICT = {
"pytorch-eqa-bert-base-cased": {
"model_id": "pytorch-eqa-bert-base-cased",
Expand Down Expand Up @@ -1093,6 +1218,7 @@
"training_artifact_key": "pytorch-training/train-pytorch-ic-mobilenet-v2.tar.gz",
"hosting_script_key": "source-directory-tarballs/pytorch/inference/ic/v1.0.0/sourcedir.tar.gz",
"training_script_key": "source-directory-tarballs/pytorch/transfer_learning/ic/v1.0.0/sourcedir.tar.gz",
"training_prepacked_script_key": None,
"hyperparameters": [
{
"name": "epochs",
Expand Down
13 changes: 13 additions & 0 deletions tests/unit/sagemaker/jumpstart/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
BASE_MANIFEST,
BASE_SPEC,
BASE_HEADER,
SPECIAL_MODEL_SPECS_DICT,
)


Expand Down Expand Up @@ -92,6 +93,18 @@ def get_prototype_model_spec(
return specs


def get_special_model_spec(
region: str = None, model_id: str = None, version: str = None
) -> JumpStartModelSpecs:
"""This function mocks cache accessor functions. For this mock,
we only retrieve model specs based on the model ID. This is reserved
for special specs.
"""

specs = JumpStartModelSpecs(SPECIAL_MODEL_SPECS_DICT[model_id])
return specs


def get_spec_from_base_spec(
_obj: JumpStartModelsCache = None,
region: str = None,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Copyright 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 mock.mock import patch

from sagemaker import script_uris

from tests.unit.sagemaker.jumpstart.utils import get_special_model_spec


@patch("sagemaker.jumpstart.accessors.JumpStartModelsAccessor.get_model_specs")
def test_jumpstart_combined_artifacts(patched_get_model_specs):

patched_get_model_specs.side_effect = get_special_model_spec

model_id_combined_script_artifact = "mock-model-training-prepacked-script-key"

uri = script_uris.retrieve(
region="us-west-2",
script_scope="inference",
model_id=model_id_combined_script_artifact,
model_version="*",
)
assert (
uri == "s3://jumpstart-cache-prod-us-west-2/some/key/to/"
"training_prepacked_script_key.tar.gz"
)