Script URIs
Accessors to retrieve the script Amazon S3 URI to run pretrained machine learning models.
- sagemaker.script_uris.retrieve(region=None, model_id=None, model_version=None, hub_arn=None, script_scope=None, tolerate_vulnerable_model=False, tolerate_deprecated_model=False, sagemaker_session=<sagemaker.session.Session object>, config_name=None, model_type=JumpStartModelType.OPEN_WEIGHTS)
Retrieves the script S3 URI associated with the model matching the given arguments.
- Parameters:
region (str) – The AWS Region for which to retrieve the model script S3 URI.
model_id (str) – The model ID of the JumpStart model for which to retrieve the script S3 URI.
model_version (str) – The version of the JumpStart model for which to retrieve the model script S3 URI.
hub_arn (str) – The arn of the SageMaker Hub for which to retrieve model details from. (Default: None).
script_scope (str) – The script type. Valid values: “training” and “inference”.
tolerate_vulnerable_model (bool) –
True
if vulnerable versions of model specifications should be tolerated without raising an exception. IfFalse
, raises an exception if the script used by this version of the model has dependencies with known security vulnerabilities. (Default: False).tolerate_deprecated_model (bool) –
True
if deprecated models should be tolerated without raising an exception.False
if these models should raise an exception. (Default: False).sagemaker_session (sagemaker.session.Session) – A SageMaker Session object, used for SageMaker interactions. If not specified, one is created using the default AWS configuration chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
config_name (Optional[str]) – Name of the JumpStart Model config to apply. (Default: None).
model_type (JumpStartModelType) – The type of the model, can be open weights model or proprietary model. (Default: JumpStartModelType.OPEN_WEIGHTS).
- Returns:
The model script URI for the corresponding model.
- Return type:
- Raises:
NotImplementedError – If the scope is not supported.
ValueError – If the combination of arguments specified is not supported.
VulnerableJumpStartModelError – If any of the dependencies required by the script have known security vulnerabilities.
DeprecatedJumpStartModelError – If the version of the model is deprecated.