File size: 12,741 Bytes
476455e | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 | # 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.
"""The `ModelStep` definition for SageMaker Pipelines Workflows"""
from __future__ import absolute_import
import logging
from typing import Union, List, Dict, Optional
from sagemaker import Model, PipelineModel, Session
from sagemaker.workflow._utils import _RegisterModelStep, _RepackModelStep
from sagemaker.workflow.pipeline_context import PipelineSession, _ModelStepArguments
from sagemaker.workflow.retry import RetryPolicy, SageMakerJobStepRetryPolicy
from sagemaker.workflow.step_collections import StepCollection
from sagemaker.workflow.steps import Step, CreateModelStep
_CREATE_MODEL_RETRY_POLICIES = "create_model_retry_policies"
_REGISTER_MODEL_RETRY_POLICIES = "register_model_retry_policies"
_REPACK_MODEL_RETRY_POLICIES = "repack_model_retry_policies"
_REGISTER_MODEL_NAME_BASE = "RegisterModel"
_CREATE_MODEL_NAME_BASE = "CreateModel"
_REPACK_MODEL_NAME_BASE = "RepackModel"
class ModelStep(StepCollection):
"""`ModelStep` for SageMaker Pipelines Workflows."""
def __init__(
self,
name: str,
step_args: _ModelStepArguments,
depends_on: Optional[List[Union[str, Step, StepCollection]]] = None,
retry_policies: Optional[Union[List[RetryPolicy], Dict[str, List[RetryPolicy]]]] = None,
display_name: Optional[str] = None,
description: Optional[str] = None,
):
"""Constructs a `ModelStep`.
Args:
name (str): The name of the `ModelStep`. A name is required and must be
unique within a pipeline.
step_args (_ModelStepArguments): The arguments for the `ModelStep` definition,
generated by invoking the :func:`~sagemaker.model.Model.register` or
:func:`~sagemaker.model.Model.create`
under the :class:`~sagemaker.workflow.pipeline_context.PipelineSession`. Example::
model = Model(sagemaker_session=PipelineSession())
model_step = ModelStep(step_args=model.register())
depends_on (List[Union[str, Step, StepCollection]]):
A list of `Step` or `StepCollection`
names or `Step` instances or `StepCollection` instances that it depends on.
If a listed `Step` name does not exist, an error is returned (default: None).
retry_policies (List[RetryPolicy] or Dict[str, List[RetryPolicy]]): The list of retry
policies for the `ModelStep` (default: None).
If a list of retry policies is provided, it would be applied to all steps in the
`ModelStep` collection. Note: in this case, `SageMakerJobStepRetryPolicy`
is not allowed, since create/register model step does not support it.
Please find the example below:
.. code:: python
ModelStep(
...
retry_policies=[
StepRetryPolicy(...),
],
)
If a dict is provided, it can specify different retry policies for different
types of steps in the `ModelStep` collection. Similarly,
`SageMakerJobStepRetryPolicy` is not allowed for create/register model step.
See examples below:
.. code:: python
ModelStep(
...
retry_policies=dict(
register_model_retry_policies=[
StepRetryPolicy(...),
],
repack_model_retry_policies=[
SageMakerJobStepRetryPolicy(...),
],
)
)
or
.. code:: python
ModelStep(
...
retry_policies=dict(
create_model_retry_policies=[
StepRetryPolicy(...),
],
repack_model_retry_policies=[
SageMakerJobStepRetryPolicy(...),
],
)
)
display_name (str): The display name of the `ModelStep`.
The display name provides better UI readability. (default: None).
description (str): The description of the `ModelStep` (default: None).
"""
from sagemaker.workflow.utilities import validate_step_args_input
validate_step_args_input(
step_args=step_args,
expected_caller={
Session.create_model.__name__,
Session.create_model_package_from_containers.__name__,
},
error_message="The step_args of ModelStep must be obtained from model.create() "
"or model.register(). For more, see: https://sagemaker.readthedocs.io/en/stable/"
"amazon_sagemaker_model_building_pipeline.html#model-step",
)
if not (step_args.create_model_request is None) ^ (
step_args.create_model_package_request is None
):
raise ValueError(
"Invalid step_args: either _register_model_args or _create_model_args"
" should be provided. They are mutually exclusive. Please use the model's "
".create() or .register() method to generate the step_args under PipelineSession."
)
if not isinstance(step_args.model.sagemaker_session, PipelineSession):
raise TypeError(
"To correctly configure a ModelStep, "
"the sagemaker_session of the model must be a PipelineSession object."
)
self.name = name
self.step_args = step_args
self.depends_on = depends_on
self.retry_policies = retry_policies
self.display_name = display_name
self.description = description
self.steps: List[Step] = []
self._model = step_args.model
self._create_model_args = self.step_args.create_model_request
self._register_model_args = self.step_args.create_model_package_request
self._need_runtime_repack = self.step_args.need_runtime_repack
self._runtime_repack_output_prefix = self.step_args.runtime_repack_output_prefix
self._assign_and_validate_retry_policies(retry_policies)
if self._need_runtime_repack:
self._append_repack_model_step()
if self._register_model_args:
self._append_register_model_step()
else:
self._append_create_model_step()
def _assign_and_validate_retry_policies(self, retry_policies):
"""Assign and validate retry policies according to each kind of sub steps
Args:
retry_policies (List[RetryPolicy] or Dict[str, List[RetryPolicy]]): The list of retry
policies for the `ModelStep`.
"""
if isinstance(retry_policies, dict):
self._create_model_retry_policies = retry_policies.get(
_CREATE_MODEL_RETRY_POLICIES, None
)
self._register_model_retry_policies = retry_policies.get(
_REGISTER_MODEL_RETRY_POLICIES, None
)
self._repack_model_retry_policies = retry_policies.get(
_REPACK_MODEL_RETRY_POLICIES, None
)
else:
self._create_model_retry_policies = retry_policies
self._register_model_retry_policies = retry_policies
self._repack_model_retry_policies = retry_policies
self._validate_sagemaker_job_step_retry_policy()
def _validate_sagemaker_job_step_retry_policy(self):
"""Validate SageMakerJobStepRetryPolicy
Validate that SageMakerJobStepRetryPolicy is not assigning to create/register model step.
"""
retry_policies = set(
(self._create_model_retry_policies or []) + (self._register_model_retry_policies or [])
)
for policy in retry_policies:
if not isinstance(policy, SageMakerJobStepRetryPolicy):
continue
raise ValueError(
"SageMakerJobStepRetryPolicy is not allowed for a create/register"
" model step. Please use StepRetryPolicy instead"
)
def _append_register_model_step(self):
"""Create and append a `_RegisterModelStep`"""
register_model_step = _RegisterModelStep(
name="{}-{}".format(self.name, _REGISTER_MODEL_NAME_BASE),
step_args=self._register_model_args,
display_name=self.display_name,
retry_policies=self._register_model_retry_policies,
description=self.description,
)
if not self._need_runtime_repack:
register_model_step.add_depends_on(self.depends_on)
self.steps.append(register_model_step)
def _append_create_model_step(self):
"""Create and append a `CreateModelStep`"""
create_model_step = CreateModelStep(
name="{}-{}".format(self.name, _CREATE_MODEL_NAME_BASE),
step_args=self._create_model_args,
retry_policies=self._create_model_retry_policies,
display_name=self.display_name,
description=self.description,
)
if not self._need_runtime_repack:
create_model_step.add_depends_on(self.depends_on)
self.steps.append(create_model_step)
def _append_repack_model_step(self):
"""Create and append a `_RepackModelStep` for the runtime repack"""
if isinstance(self._model, PipelineModel):
model_list = self._model.models
elif isinstance(self._model, Model):
model_list = [self._model]
else:
logging.warning("No models to repack")
return
security_group_ids = None
subnets = None
if self._model.vpc_config:
security_group_ids = self._model.vpc_config.get("SecurityGroupIds", None)
subnets = self._model.vpc_config.get("Subnets", None)
for i, model in enumerate(model_list):
runtime_repack_flg = (
self._need_runtime_repack and id(model) in self._need_runtime_repack
)
if runtime_repack_flg:
name_base = model.name or i
repack_model_step = _RepackModelStep(
name="{}-{}-{}".format(self.name, _REPACK_MODEL_NAME_BASE, name_base),
sagemaker_session=self._model.sagemaker_session or model.sagemaker_session,
role=self._model.role or model.role,
model_data=model.model_data,
entry_point=model.entry_point,
source_dir=model.source_dir,
dependencies=model.dependencies,
subnets=subnets,
security_group_ids=security_group_ids,
description=(
"Used to repack a model with customer scripts for a "
"register/create model step"
),
depends_on=self.depends_on,
retry_policies=self._repack_model_retry_policies,
output_path=self._runtime_repack_output_prefix,
)
self.steps.append(repack_model_step)
repacked_model_data = repack_model_step.properties.ModelArtifacts.S3ModelArtifacts
if self._create_model_args:
if isinstance(self._model, PipelineModel):
container = self.step_args.create_model_request["Containers"][i]
else:
container = self.step_args.create_model_request["PrimaryContainer"]
else:
container = self.step_args.create_model_package_request[
"InferenceSpecification"
]["Containers"][i]
container["ModelDataUrl"] = repacked_model_data
|