Content Types

This module is for SageMaker content types.

sagemaker.content_types.retrieve_options(region=None, model_id=None, model_version=None, hub_arn=None, tolerate_vulnerable_model=False, tolerate_deprecated_model=False, sagemaker_session=<sagemaker.session.Session object>)

Retrieves the supported content types for the model matching the given arguments.

Parameters:

  • region (str) – The AWS Region for which to retrieve the supported content types. Defaults to None.

  • model_id (str) – The model ID of the model for which to retrieve the supported content types. (Default: None).

  • model_version (str) – The version of the model for which to retrieve the supported content types. (Default: None).

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

  • tolerate_vulnerable_model (bool) – True if vulnerable versions of model specifications should be tolerated (exception not raised). 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 models should be tolerated (exception not raised). 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).

Returns:

The supported content types to use for the model.

Return type:

list

Raises:

ValueError – If the combination of arguments specified is not supported.

sagemaker.content_types.retrieve_default(region=None, model_id=None, model_version=None, hub_arn=None, tolerate_vulnerable_model=False, tolerate_deprecated_model=False, sagemaker_session=<sagemaker.session.Session object>, model_type=JumpStartModelType.OPEN_WEIGHTS, config_name=None)

Retrieves the default content type for the model matching the given arguments.

Parameters:

  • region (str) – The AWS Region for which to retrieve the default content type. Defaults to None.

  • model_id (str) – The model ID of the model for which to retrieve the default content type. (Default: None).

  • model_version (str) – The version of the model for which to retrieve the default content type. (Default: None).

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

  • tolerate_vulnerable_model (bool) – True if vulnerable versions of model specifications should be tolerated (exception not raised). 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 models should be tolerated (exception not raised). 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) –

Returns:

The default content type to use for the model.

Return type:

str

Raises:

ValueError – If the combination of arguments specified is not supported.