sagemaker.core.jumpstart.notebook_utils

This module stores notebook utils related to SageMaker JumpStart.

Functions

extract_framework_task_model(model_id)	Parse the model ID, return a tuple framework, task, rest-of-id.
extract_model_type_filter_representation(...)	Parses model spec key, determine if the model is proprietary or open weight.
get_model_url(model_id, model_version[, ...])	Retrieve web url describing pretrained model.
list_jumpstart_frameworks([filter, region, ...])	List frameworks for JumpStart, and optionally apply filters to result.
list_jumpstart_models([filter, region, ...])	List models for JumpStart, and optionally apply filters to result.
list_jumpstart_scripts([filter, region, ...])	List scripts for JumpStart, and optionally apply filters to result.
list_jumpstart_tasks([filter, region, ...])	List tasks for JumpStart, and optionally apply filters to result.

sagemaker.core.jumpstart.notebook_utils.extract_framework_task_model(model_id: str) → Tuple[str, str, str]

Parse the model ID, return a tuple framework, task, rest-of-id.

Parameters:

model_id (str) – The model ID for which to extract the framework/task/model.

sagemaker.core.jumpstart.notebook_utils.extract_model_type_filter_representation(spec_key: str) → str

Parses model spec key, determine if the model is proprietary or open weight.

Parameters:

spek_key (str) – The model spec key for which to extract the model type.

sagemaker.core.jumpstart.notebook_utils.get_model_url(model_id: str, model_version: str, region: str | None = None, sagemaker_session: ~sagemaker.core.helper.session_helper.Session = <sagemaker.core.helper.session_helper.Session object>, config_name: str | None = None) → str

Retrieve web url describing pretrained model.

Parameters:

• model_id (str) – The model ID for which to retrieve the url.

• model_version (str) – The model version for which to retrieve the url.

• region (str) – Optional. The region from which to retrieve metadata. (Default: None)

• sagemaker_session (sagemaker.session.Session) – Optional. The SageMaker Session to use to retrieve the model url.

sagemaker.core.jumpstart.notebook_utils.list_jumpstart_frameworks(filter: ~sagemaker.core.jumpstart.filters.Operator | str = <sagemaker.core.jumpstart.filters.Constant object>, region: str | None = None, sagemaker_session: ~sagemaker.core.helper.session_helper.Session = <sagemaker.core.helper.session_helper.Session object>) → List[str]

List frameworks for JumpStart, and optionally apply filters to result.

Parameters:

• filter (Union[Operator, str]) – Optional. The filter to apply to list frameworks. This can be either an Operator type filter (e.g. And("task == ic", "framework == pytorch")), or simply a string filter which will get serialized into an Identity filter. (eg. "task == ic"). If this argument is not supplied, all frameworks will be listed. (Default: Constant(BooleanValues.TRUE)).

• region (str) – Optional. The AWS region from which to retrieve JumpStart metadata regarding models. (Default: None).

• sagemaker_session (sagemaker.session.Session) – Optional. The SageMaker Session to use to perform the model search. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).

sagemaker.core.jumpstart.notebook_utils.list_jumpstart_models(filter: ~sagemaker.core.jumpstart.filters.Operator | str = <sagemaker.core.jumpstart.filters.Constant object>, region: str | None = None, list_incomplete_models: bool = False, list_old_models: bool = False, list_versions: bool = False, sagemaker_session: ~sagemaker.core.helper.session_helper.Session = <sagemaker.core.helper.session_helper.Session object>) → List[Tuple[str] | Tuple[str, str]]

List models for JumpStart, and optionally apply filters to result.

Parameters:

• filter (Union[Operator, str]) – Optional. The filter to apply to list models. This can be either an Operator type filter (e.g. And("task == ic", "framework == pytorch")), or simply a string filter which will get serialized into an Identity filter. (e.g. "task == ic"). If this argument is not supplied, all models will be listed. (Default: Constant(BooleanValues.TRUE)).

• region (str) – Optional. The AWS region from which to retrieve JumpStart metadata regarding models. (Default: None).

• list_incomplete_models (bool) – Optional. If a model does not contain metadata fields requested by the filter, and the filter cannot be resolved to a include/not include, whether the model should be included. By default, these models are omitted from results. (Default: False).

• list_old_models (bool) – Optional. If there are older versions of a model, whether the older versions should be included in the returned result. (Default: False).

• list_versions (bool) – Optional. True if versions for models should be returned in addition to the id of the model. (Default: False).

• sagemaker_session (sagemaker.session.Session) – Optional. The SageMaker Session to use to perform the model search. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).

sagemaker.core.jumpstart.notebook_utils.list_jumpstart_scripts(filter: ~sagemaker.core.jumpstart.filters.Operator | str = <sagemaker.core.jumpstart.filters.Constant object>, region: str | None = None, sagemaker_session: ~sagemaker.core.helper.session_helper.Session = <sagemaker.core.helper.session_helper.Session object>) → List[str]

List scripts for JumpStart, and optionally apply filters to result.

Parameters:

• filter (Union[Operator, str]) – Optional. The filter to apply to list scripts. This can be either an Operator type filter (e.g. And("task == ic", "framework == pytorch")), or simply a string filter which will get serialized into an Identity filter. (e.g. "task == ic"). If this argument is not supplied, all scripts will be listed. (Default: Constant(BooleanValues.TRUE)).

• region (str) – Optional. The AWS region from which to retrieve JumpStart metadata regarding models. (Default: None).

• sagemaker_session (sagemaker.session.Session) – Optional. The SageMaker Session to use to perform the model search. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).

sagemaker.core.jumpstart.notebook_utils.list_jumpstart_tasks(filter: ~sagemaker.core.jumpstart.filters.Operator | str = <sagemaker.core.jumpstart.filters.Constant object>, region: str | None = None, sagemaker_session: ~sagemaker.core.helper.session_helper.Session = <sagemaker.core.helper.session_helper.Session object>) → List[str]

List tasks for JumpStart, and optionally apply filters to result.

Parameters:

• filter (Union[Operator, str]) – Optional. The filter to apply to list tasks. This can be either an Operator type filter (e.g. And("task == ic", "framework == pytorch")), or simply a string filter which will get serialized into an Identity filter. (e.g. "task == ic"). If this argument is not supplied, all tasks will be listed. (Default: Constant(BooleanValues.TRUE)).

• region (str) – Optional. The AWS region from which to retrieve JumpStart metadata regarding models. (Default: None).

• sagemaker_session (sagemaker.session.Session) – Optional. The SageMaker Session to use to perform the model search. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).