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, model_scope=None, tolerate_vulnerable_model=False, tolerate_deprecated_model=False)

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.

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

  • 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).

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.