sagemaker.core.jumpstart.validators

sagemaker.core.jumpstart.validators#

This module contains validators related to SageMaker JumpStart.

Functions

validate_hyperparameters(model_id, ...[, ...])

Validate hyperparameters for JumpStart models.
sagemaker.core.jumpstart.validators.validate_hyperparameters(model_id: str, model_version: str, hyperparameters: Dict[str, Any], validation_mode: HyperparameterValidationMode = HyperparameterValidationMode.VALIDATE_PROVIDED, hub_arn: str | None = None, region: str | None = None, sagemaker_session: Session | None = None, tolerate_vulnerable_model: bool = False, tolerate_deprecated_model: bool = False, config_name: str | None = None) → None[source]#

Validate hyperparameters for JumpStart models.

Parameters:

  • model_id (str) – Model ID of the model for which to validate hyperparameters.

  • model_version (str) – Version of the model for which to validate hyperparameters.

  • hyperparameters (dict) – Hyperparameters to validate.

  • validation_mode (HyperparameterValidationMode) – Method of validation to use with hyperparameters. If set to VALIDATE_PROVIDED, only hyperparameters provided to this function will be validated, the missing hyperparameters will be ignored. If set to``VALIDATE_ALGORITHM``, all algorithm hyperparameters will be validated. If set to VALIDATE_ALL, all hyperparameters for the model will be validated.

  • region (str) – Region for which to validate hyperparameters. (Default: None).

  • sagemaker_session (Optional[Session]) – Custom SageMaker Session to use. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).

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

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

Raises:

JumpStartHyperparametersError – If the hyperparameters are not formatted correctly, according to their metadata specs.

Contents