Model URIs

Accessors to retrieve the model artifact S3 URI of pretrained machine learning models.

sagemaker.model_uris.retrieve(region=None, model_id=None, model_version=None, hub_arn=None, model_scope=None, instance_type=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 model artifact Amazon S3 URI for the model matching the given arguments.

Parameters

  • region (str) – The AWS Region for which to retrieve the Jumpstart model S3 URI.

  • model_id (str) – The model ID of the JumpStart model for which to retrieve the model artifact S3 URI.

  • model_version (str) – The version of the JumpStart model for which to retrieve the model artifact S3 URI.

  • hub_arn (str) – The arn of the SageMaker Hub for which to retrieve model details from. (default: None).

  • model_scope (str) – The model type. Valid values: “training” and “inference”.

  • instance_type (str) – The ML compute instance type for the specified scope. (Default: None).

  • tolerate_vulnerable_model (bool) – True if vulnerable versions of model specifications should be tolerated without raising an exception. If False, 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 versions of model specifications should be tolerated without raising an exception. If False, raises an exception if the version of the model is deprecated. (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 artifact S3 URI for the corresponding model.

Return type

str

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.