sagemaker.core.resource_requirements

sagemaker.core.resource_requirements#

Accessors to retrieve resource requirements.

Functions

retrieve_default([region, model_id, ...])

Retrieves the default resource requirements for the model matching the given arguments.

Classes

ResourceRequirements([requests, limits])

Configures the compute resources for a Model.
class sagemaker.core.resource_requirements.ResourceRequirements(requests: Dict[str, int] | None = None, limits: Dict[str, int] | None = None)[source]#

Bases: object

Configures the compute resources for a Model.

get_compute_resource_requirements() → dict[source]#

Returns a dict of resource requirements.

sagemaker.core.resource_requirements.retrieve_default(region: str | None = None, model_id: str | None = None, model_version: str | None = None, hub_arn: str | None = None, scope: str | None = None, tolerate_vulnerable_model: bool = False, tolerate_deprecated_model: bool = False, model_type: ~sagemaker.core.jumpstart.enums.JumpStartModelType = JumpStartModelType.OPEN_WEIGHTS, sagemaker_session: ~sagemaker.core.helper.session_helper.Session = <sagemaker.core.helper.session_helper.Session object>, instance_type: str | None = None, config_name: str | None = None) → ResourceRequirements[source]#

Retrieves the default resource requirements for the model matching the given arguments.

Parameters:

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

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

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

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

  • scope (str) – The model type, i.e. what it is used for. Valid values: “training” and “inference”.

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

  • instance_type (str) – An instance type to optionally supply in order to get host requirements specific for the instance type.

  • config_name (Optional[str]) – Name of the JumpStart Model config to apply. (Default: None).

Returns:

The default resource requirements to use for the model.

Return type:

str

Raises:

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

Contents