sagemaker.core.jumpstart.enums

This module stores enums related to SageMaker JumpStart.

Classes

DeserializerType(value)	Enum class for deserializers associated with JumpStart models.
HubContentCapability(value)	Enum class for HubContent capabilities.
HyperparameterValidationMode(value)	Possible modes for validating hyperparameters.
JumpStartConfigRankingName(value)	Enum class for ranking of JumpStart config.
JumpStartModelType(value)	Enum class for JumpStart model type.
JumpStartScriptScope(value)	Enum class for JumpStart script scopes.
JumpStartTag(value)	Enum class for tag keys to apply to JumpStart models.
MIMEType(value)	Enum class for MIME types associated with JumpStart models.
ModelFramework(value)	Enum class for JumpStart model framework.
ModelSpecKwargType(value)	Enum class for types of kwargs for model hub content document and model specs.
NamingConventionType(value)	Enum class for naming conventions.
SerializerType(value)	Enum class for serializers associated with JumpStart models.
VariableScope(value)	Possible value of the scope attribute for a hyperparameter or environment variable.
VariableTypes(value)	Possible types for hyperparameters and environment variables.

class sagemaker.core.jumpstart.enums.DeserializerType(value)

Bases: str, Enum

Enum class for deserializers associated with JumpStart models.

JSON = 'json'

class sagemaker.core.jumpstart.enums.HubContentCapability(value)

Bases: str, Enum

Enum class for HubContent capabilities.

BEDROCK_CONSOLE = 'BEDROCK_CONSOLE'

class sagemaker.core.jumpstart.enums.HyperparameterValidationMode(value)

Bases: str, Enum

Possible modes for validating hyperparameters.

VALIDATE_ALGORITHM = 'validate_algorithm'

VALIDATE_ALL = 'validate_all'

VALIDATE_PROVIDED = 'validate_provided'

class sagemaker.core.jumpstart.enums.JumpStartConfigRankingName(value)

Bases: str, Enum

Enum class for ranking of JumpStart config.

DEFAULT = 'overall'

class sagemaker.core.jumpstart.enums.JumpStartModelType(value)

Bases: str, Enum

Enum class for JumpStart model type.

OPEN_WEIGHTS: Publicly available models have open weights and are onboarded and maintained by JumpStart. PROPRIETARY: Proprietary models from third-party providers do not have open weights. You must subscribe to proprietary models in AWS Marketplace before use.

OPEN_WEIGHTS = 'open_weights'

PROPRIETARY = 'proprietary'

class sagemaker.core.jumpstart.enums.JumpStartScriptScope(value)

Bases: str, Enum

Enum class for JumpStart script scopes.

INFERENCE = 'inference'

TRAINING = 'training'

class sagemaker.core.jumpstart.enums.JumpStartTag(value)

Bases: str, Enum

Enum class for tag keys to apply to JumpStart models.

BEDROCK = 'sagemaker-sdk:bedrock'

HUB_CONTENT_ARN = 'sagemaker-sdk:hub-content-arn'

INFERENCE_CONFIG_NAME = 'sagemaker-sdk:jumpstart-inference-config-name'

INFERENCE_MODEL_URI = 'aws-jumpstart-inference-model-uri'

INFERENCE_SCRIPT_URI = 'aws-jumpstart-inference-script-uri'

MODEL_ID = 'sagemaker-sdk:jumpstart-model-id'

MODEL_TYPE = 'sagemaker-sdk:jumpstart-model-type'

MODEL_VERSION = 'sagemaker-sdk:jumpstart-model-version'

TRAINING_CONFIG_NAME = 'sagemaker-sdk:jumpstart-training-config-name'

TRAINING_MODEL_URI = 'aws-jumpstart-training-model-uri'

TRAINING_SCRIPT_URI = 'aws-jumpstart-training-script-uri'

class sagemaker.core.jumpstart.enums.MIMEType(value)

Bases: str, Enum

Enum class for MIME types associated with JumpStart models.

CSV = 'text/csv'

JSON = 'application/json'

LIST_TEXT = 'application/list-text'

WAV = 'audio/wav'

X_IMAGE = 'application/x-image'

X_TEXT = 'application/x-text'

static from_suffixed_type(mime_type_with_suffix: str) → MIMEType

Removes suffix from type and instantiates enum.

class sagemaker.core.jumpstart.enums.ModelFramework(value)

Bases: str, Enum

Enum class for JumpStart model framework.

The ML framework as referenced in the prefix of the model ID. This value does not necessarily correspond to the container name.

CATBOOST = 'catboost'

HUGGINGFACE = 'huggingface'

LIGHTGBM = 'lightgbm'

MXNET = 'mxnet'

PYTORCH = 'pytorch'

SKLEARN = 'sklearn'

TENSORFLOW = 'tensorflow'

XGBOOST = 'xgboost'

class sagemaker.core.jumpstart.enums.ModelSpecKwargType(value)

Bases: str, Enum

Enum class for types of kwargs for model hub content document and model specs.

DEPLOY = 'deploy_kwargs'

ESTIMATOR = 'estimator_kwargs'

FIT = 'fit_kwargs'

MODEL = 'model_kwargs'

classmethod arg_keys() → List[str]

Returns a list of kwargs keys that each type can have

class sagemaker.core.jumpstart.enums.NamingConventionType(value)

Bases: str, Enum

Enum class for naming conventions.

DEFAULT = 'upper_camel_case'

SNAKE_CASE = 'snake_case'

UPPER_CAMEL_CASE = 'upper_camel_case'

class sagemaker.core.jumpstart.enums.SerializerType(value)

Bases: str, Enum

Enum class for serializers associated with JumpStart models.

CSV = 'csv'

JSON = 'json'

RAW_BYTES = 'raw_bytes'

TEXT = 'text'

class sagemaker.core.jumpstart.enums.VariableScope(value)

Bases: str, Enum

Possible value of the scope attribute for a hyperparameter or environment variable.

Used for hosting environment variables and training hyperparameters.

ALGORITHM = 'algorithm'

CONTAINER = 'container'

class sagemaker.core.jumpstart.enums.VariableTypes(value)

Bases: str, Enum

Possible types for hyperparameters and environment variables.

BOOL = 'bool'

FLOAT = 'float'

INT = 'int'

TEXT = 'text'