add accept_draft_model_eula to JumpStartModel when deployment config with gated draft model is selected

Author: EC2 Default User

src/sagemaker/jumpstart/factory/model.py

@@ -58,6 +58,7 @@
     update_dict_if_key_not_present,
     resolve_model_sagemaker_config_field,
     verify_model_region_and_return_specs,
+    get_jumpstart_content_bucket,
 )
 
 from sagemaker.jumpstart.factory.utils import (
@@ -70,7 +71,13 @@
 
 from sagemaker.serverless.serverless_inference_config import ServerlessInferenceConfig
 from sagemaker.session import Session
-from sagemaker.utils import camel_case_to_pascal_case, name_from_base, format_tags, Tags
+from sagemaker.utils import (
+    camel_case_to_pascal_case,
+    name_from_base,
+    format_tags,
+    Tags,
+    get_domain_for_region,
+)
 from sagemaker.workflow.entities import PipelineVariable
 from sagemaker.compute_resource_requirements.resource_requirements import ResourceRequirements
 from sagemaker import resource_requirements
@@ -556,6 +563,37 @@ def _add_config_name_to_init_kwargs(kwargs: JumpStartModelInitKwargs) -> JumpSta
     return kwargs
 
 
+def _apply_accept_eula_on_model_data_source(
+    model_data_source: Dict[str, Any],
+    model_id: str,
+    region: str,
+    accept_eula: bool
+):
+    """Sets AcceptEula to True for gated speculative decoding models"""
+
+    mutable_model_data_source = model_data_source.copy()
+
+    hosting_eula_key = mutable_model_data_source.get("hosting_eula_key")
+    del mutable_model_data_source["hosting_eula_key"]
+
+    if not hosting_eula_key:
+        return mutable_model_data_source
+
+    if not accept_eula:
+        raise ValueError(
+            (
+                f"The set deployment config comes optimized with an additional model data source "
+                f"'{model_id}' that requires accepting end-user license agreement (EULA). "
+                f"See https://{get_jumpstart_content_bucket(region=region)}.s3.{region}."
+                f"{get_domain_for_region(region)}"
+                f"/{hosting_eula_key} for terms of use. Please set `accept_eula=True` once acknowledged."
+            )
+        )
+
+    mutable_model_data_source["model_access_config"] = {"accept_eula": accept_eula}
+    return mutable_model_data_source
+
+
 def _add_additional_model_data_sources_to_kwargs(
     kwargs: JumpStartModelInitKwargs,
 ) -> JumpStartModelInitKwargs:
@@ -568,7 +606,11 @@ def _add_additional_model_data_sources_to_kwargs(
         data_source.s3_data_source.set_bucket(get_neo_content_bucket(region=kwargs.region))
     api_shape_additional_model_data_sources = (
         [
-            camel_case_to_pascal_case(data_source.to_json())
+            camel_case_to_pascal_case(
+                _apply_accept_eula_on_model_data_source(
+                    data_source.to_json(), kwargs.model_id, kwargs.region, kwargs.accept_draft_model_eula,
+                )
+            )
             for data_source in speculative_decoding_data_sources
         ]
         if specs.get_speculative_decoding_s3_data_sources()
@@ -858,6 +900,7 @@ def get_init_kwargs(
     resources: Optional[ResourceRequirements] = None,
     config_name: Optional[str] = None,
     additional_model_data_sources: Optional[Dict[str, Any]] = None,
+    accept_draft_model_eula: Optional[bool] = None,
 ) -> JumpStartModelInitKwargs:
     """Returns kwargs required to instantiate `sagemaker.estimator.Model` object."""
 
@@ -892,6 +935,7 @@ def get_init_kwargs(
         resources=resources,
         config_name=config_name,
         additional_model_data_sources=additional_model_data_sources,
+        accept_draft_model_eula=accept_draft_model_eula,
     )
     model_init_kwargs, orig_session = _set_temp_sagemaker_session_if_not_set(
         kwargs=model_init_kwargs

src/sagemaker/jumpstart/model.py

@@ -111,6 +111,7 @@ def __init__(
         resources: Optional[ResourceRequirements] = None,
         config_name: Optional[str] = None,
         additional_model_data_sources: Optional[Dict[str, Any]] = None,
+        accept_draft_model_eula: Optional[bool] = None,
     ):
         """Initializes a ``JumpStartModel``.
 
@@ -301,6 +302,10 @@ def __init__(
                 optionally applied to the model.
             additional_model_data_sources (Optional[Dict[str, Any]]): Additional location
                 of SageMaker model data (default: None).
+            accept_draft_model_eula (bool): For draft models that require a Model Access Config, specify True or
+                False to indicate whether model terms of use have been accepted.
+                The `accept_draft_model_eula` value must be explicitly defined as `True` in order to
+                accept the end-user license agreement (EULA) that some
         Raises:
             ValueError: If the model ID is not recognized by JumpStart.
         """
@@ -360,6 +365,7 @@ def _validate_model_id_and_type():
             resources=resources,
             config_name=config_name,
             additional_model_data_sources=additional_model_data_sources,
+            accept_draft_model_eula=accept_draft_model_eula
         )
 
         self.orig_predictor_cls = predictor_cls
@@ -456,7 +462,9 @@ def retrieve_example_payload(self) -> JumpStartSerializablePayload:
             sagemaker_session=self.sagemaker_session,
         )
 
-    def set_deployment_config(self, config_name: str, instance_type: str) -> None:
+    def set_deployment_config(
+        self, config_name: str, instance_type: str, accept_draft_model_eula: Optional[bool] = False
+    ) -> None:
         """Sets the deployment config to apply to the model.
 
         Args:
@@ -466,6 +474,8 @@ def set_deployment_config(self, config_name: str, instance_type: str) -> None:
             instance_type (str):
                 The instance_type that the model will use after setting
                 the config.
+            accept_draft_model_eula (Optional[bool]):
+                If the config selected comes with a gated additional model data source.
         """
         self.__init__(
             model_id=self.model_id,
@@ -474,6 +484,7 @@ def set_deployment_config(self, config_name: str, instance_type: str) -> None:
             config_name=config_name,
             sagemaker_session=self.sagemaker_session,
             role=self.role,
+            accept_draft_model_eula=accept_draft_model_eula,
         )
 
     @property
@@ -540,12 +551,16 @@ def attach(
         inferred_model_id = inferred_model_version = inferred_inference_component_name = None
 
         if inference_component_name is None or model_id is None or model_version is None:
-            inferred_model_id, inferred_model_version, inferred_inference_component_name, _, _ = (
-                get_model_info_from_endpoint(
-                    endpoint_name=endpoint_name,
-                    inference_component_name=inference_component_name,
-                    sagemaker_session=sagemaker_session,
-                )
+            (
+                inferred_model_id,
+                inferred_model_version,
+                inferred_inference_component_name,
+                _,
+                _,
+            ) = get_model_info_from_endpoint(
+                endpoint_name=endpoint_name,
+                inference_component_name=inference_component_name,
+                sagemaker_session=sagemaker_session,
             )
 
         model_id = model_id or inferred_model_id
@@ -1016,10 +1031,11 @@ def _get_deployment_configs(
                 )
 
             if metadata_config.benchmark_metrics:
-                err, metadata_config.benchmark_metrics = (
-                    add_instance_rate_stats_to_benchmark_metrics(
-                        self.region, metadata_config.benchmark_metrics
-                    )
+                (
+                    err,
+                    metadata_config.benchmark_metrics,
+                ) = add_instance_rate_stats_to_benchmark_metrics(
+                    self.region, metadata_config.benchmark_metrics
                 )
 
             config_components = metadata_config.config_components.get(config_name)
@@ -1042,6 +1058,7 @@ def _get_deployment_configs(
                 region=self.region,
                 model_version=self.model_version,
                 hub_arn=self.hub_arn,
+                accept_draft_model_eula=True,
             )
             deploy_kwargs = get_deploy_kwargs(
                 model_id=self.model_id,

src/sagemaker/jumpstart/types.py

@@ -1083,7 +1083,7 @@ class AdditionalModelDataSource(JumpStartDataHolderType):
 
     SERIALIZATION_EXCLUSION_SET: Set[str] = set()
 
-    __slots__ = ["channel_name", "s3_data_source"]
+    __slots__ = ["channel_name", "s3_data_source", "hosting_eula_key"]
 
     def __init__(self, spec: Dict[str, Any]):
         """Initializes a AdditionalModelDataSource object.
@@ -1101,6 +1101,7 @@ def from_json(self, json_obj: Dict[str, Any]) -> None:
         """
         self.channel_name: str = json_obj["channel_name"]
         self.s3_data_source: S3DataSource = S3DataSource(json_obj["s3_data_source"])
+        self.hosting_eula_key: str = json_obj.get("hosting_eula_key")
 
     def to_json(self, exclude_keys=True) -> Dict[str, Any]:
         """Returns json representation of AdditionalModelDataSource object."""
@@ -2116,6 +2117,7 @@ class JumpStartModelInitKwargs(JumpStartKwargs):
         "hub_content_type",
         "model_reference_arn",
         "specs",
+        "accept_draft_model_eula",
     ]
 
     SERIALIZATION_EXCLUSION_SET = {
@@ -2131,6 +2133,7 @@ class JumpStartModelInitKwargs(JumpStartKwargs):
         "training_instance_type",
         "config_name",
         "hub_content_type",
+        "accept_draft_model_eula",
     }
 
     def __init__(
@@ -2165,6 +2168,7 @@ def __init__(
         resources: Optional[ResourceRequirements] = None,
         config_name: Optional[str] = None,
         additional_model_data_sources: Optional[Dict[str, Any]] = None,
+        accept_draft_model_eula: Optional[bool] = False
     ) -> None:
         """Instantiates JumpStartModelInitKwargs object."""
 
@@ -2198,6 +2202,7 @@ def __init__(
         self.resources = resources
         self.config_name = config_name
         self.additional_model_data_sources = additional_model_data_sources
+        self.accept_draft_model_eula = accept_draft_model_eula
 
 
 class JumpStartModelDeployKwargs(JumpStartKwargs):

src/sagemaker/serve/builder/jumpstart_builder.py

@@ -502,7 +502,9 @@ def tune_for_tgi_jumpstart(self, max_tuning_duration: int = 1800):
             sharded_supported=sharded_supported, max_tuning_duration=max_tuning_duration
         )
 
-    def set_deployment_config(self, config_name: str, instance_type: str) -> None:
+    def set_deployment_config(
+            self, config_name: str, instance_type: str, accept_draft_model_eula: Optional[bool] = False
+    ) -> None:
         """Sets the deployment config to apply to the model.
 
         Args:
@@ -512,11 +514,13 @@ def set_deployment_config(self, config_name: str, instance_type: str) -> None:
             instance_type (str):
                 The instance_type that the model will use after setting
                 the config.
+            accept_draft_model_eula (Optional[bool]):
+                If the config selected comes with a gated additional model data source.
         """
         if not hasattr(self, "pysdk_model") or self.pysdk_model is None:
             raise Exception("Cannot set deployment config to an uninitialized model.")
 
-        self.pysdk_model.set_deployment_config(config_name, instance_type)
+        self.pysdk_model.set_deployment_config(config_name, instance_type, accept_draft_model_eula)
         self.deployment_config_name = config_name
 
         self.instance_type = instance_type