sagemaker.core.jumpstart.hub.interfaces

sagemaker.core.jumpstart.hub.interfaces#

This module stores types related to SageMaker JumpStart HubAPI requests and responses.

Classes

`CreateHubResponse`(json_obj)	Data class for the Hub from session.create_hub()
`DescribeHubContentResponse`(json_obj)	Data class for the Hub Content from session.describe_hub_contents()
`DescribeHubResponse`(json_obj)	Data class for the Hub from session.describe_hub()
`EcrUri`(uri)	Data class for ECR image uri.
`HubContentDependency`(json_obj)	Data class for any dependencies related to hub content.
`HubContentInfo`(json_obj)	Data class for the HubContentInfo from session.list_hub_contents().
`HubDataHolderType`()	Base class for many Hub API interfaces.
`HubModelDocument`(json_obj, region[, ...])	Data class for model type HubContentDocument from session.describe_hub_content().
`HubNotebookDocument`(json_obj, region)	Data class for notebook type HubContentDocument from session.describe_hub_content().
`HubS3StorageConfig`(json_obj)	Data class for any dependencies related to hub content.
`HubSummary`(json_obj)	Data class for the HubSummary from session.list_hubs()
`ImportHubResponse`(json_obj)	Data class for the Hub from session.import_hub()
`ListHubContentsResponse`(json_obj)	Data class for the Hub from session.list_hub_contents()
`ListHubsResponse`(json_obj)	Data class for the Hub from session.list_hubs()
`NotebookLocationUris`(json_obj)	Data class for Notebook Location uri.

class sagemaker.core.jumpstart.hub.interfaces.CreateHubResponse(json_obj: Dict[str, Any])[source]#

Bases: HubDataHolderType

Data class for the Hub from session.create_hub()

from_json(json_obj: Dict[str, Any]) → None[source]#

Sets fields in object based on json.

Parameters:: json_obj (Dict[str, Any]) – Dictionary representation of hub description.

hub_arn#

class sagemaker.core.jumpstart.hub.interfaces.DescribeHubContentResponse(json_obj: Dict[str, Any])[source]#

Bases: HubDataHolderType

Data class for the Hub Content from session.describe_hub_contents()

creation_time#

document_schema_version#

failure_reason#

from_json(json_obj: Dict[str, Any]) → None[source]#

Sets fields in object based on json.

Parameters:: json_obj (Dict[str, Any]) – Dictionary representation of hub content description.

get_hub_region() → str | None[source]#: Returns the region hub is in.

hub_arn#

hub_content_arn#

hub_content_dependencies#

hub_content_description#

hub_content_display_name#

hub_content_document#

hub_content_markdown#

hub_content_name#

hub_content_search_keywords#

hub_content_status#

hub_content_type#

hub_content_version#

hub_name#

reference_min_version#

class sagemaker.core.jumpstart.hub.interfaces.DescribeHubResponse(json_obj: Dict[str, Any])[source]#

Bases: HubDataHolderType

Data class for the Hub from session.describe_hub()

creation_time#

failure_reason#

from_json(json_obj: Dict[str, Any]) → None[source]#

Sets fields in object based on json.

Parameters:: json_obj (Dict[str, Any]) – Dictionary representation of hub description.

get_hub_region() → str | None[source]#: Returns the region hub is in.

hub_arn#

hub_description#

hub_display_name#

hub_name#

hub_search_keywords#

hub_status#

last_modified_time#

s3_storage_config#

class sagemaker.core.jumpstart.hub.interfaces.EcrUri(uri: str)[source]#

Bases: HubDataHolderType

Data class for ECR image uri.

account#

from_ecr_uri(uri: str) → None[source]#: Parse a given aws ecr image uri into its various components.

region_name#

repository#

tag#

class sagemaker.core.jumpstart.hub.interfaces.HubContentDependency(json_obj: Dict[str, Any])[source]#

Bases: HubDataHolderType

Data class for any dependencies related to hub content.

Content can be scripts, model artifacts, datasets, or notebooks.

dependency_copy_path#

dependency_origin_path#

dependency_type#

from_json(json_obj: Dict[str, Any] | None) → None[source]#

Sets fields in object based on json.

Parameters:: json_obj (Dict[str, Any]) – Dictionary representation of hub content description.

class sagemaker.core.jumpstart.hub.interfaces.HubContentInfo(json_obj: Dict[str, Any])[source]#

Bases: HubDataHolderType

Data class for the HubContentInfo from session.list_hub_contents().

creation_time#

document_schema_version#

from_json(json_obj: Dict[str, Any]) → None[source]#

Sets fields in object based on json.

Parameters:: json_obj (Dict[str, Any]) – Dictionary representation of hub content description.

get_hub_region() → str | None[source]#: Returns the region hub is in.

hub_content_arn#

hub_content_description#

hub_content_display_name#

hub_content_name#

hub_content_search_keywords#

hub_content_status#

hub_content_type#

hub_content_version#

class sagemaker.core.jumpstart.hub.interfaces.HubDataHolderType[source]#

Bases: JumpStartDataHolderType

Base class for many Hub API interfaces.

to_json() → Dict[str, Any][source]#: Returns json representation of object.

class sagemaker.core.jumpstart.hub.interfaces.HubModelDocument(json_obj: Dict[str, Any], region: str, dependencies: List[HubContentDependency] | None = None)[source]#

Bases: HubDataHolderType

Data class for model type HubContentDocument from session.describe_hub_content().

SCHEMA_VERSION = '2.3.0'#

capabilities#

container_startup_health_check_timeout#

contextual_help#

datatype#

default_inference_instance_type#

default_payloads#

default_training_dataset_uri#

default_training_instance_type#

dependencies#

disable_output_compression#

dynamic_container_deployment_supported#

encrypt_inter_container_traffic#

fine_tuning_supported#

framework#

from_json(json_obj: Dict[str, Any]) → None[source]#

Sets fields in object based on json.

Parameters:: json_obj (Dict[str, Any]) – Dictionary representation of hub model document.

gated_bucket#

get_region() → str[source]#: Returns hub region.

get_schema_version() → str[source]#: Returns schema version.

hosting_artifact_compression_type#

hosting_artifact_s3_data_type#

hosting_artifact_uri#

hosting_ecr_uri#

hosting_eula_uri#

hosting_instance_type_variants#

hosting_model_package_arn#

hosting_prepacked_artifact_uri#

hosting_prepacked_artifact_version#

hosting_resource_requirements#

hosting_script_uri#

hosting_use_script_uri#

hyperparameters#

incremental_training_supported#

inference_ami_version#

inference_config_components#

inference_config_rankings#

inference_configs#

inference_dependencies#

inference_enable_network_isolation#

inference_environment_variables#

inference_volume_size#

license#

max_runtime_in_seconds#

min_sdk_version#

model_data_download_timeout#

model_dir#

model_provider_icon_uri#

model_subscription_link#

model_types#

notebook_location_uris#

resource_name_base#

sage_maker_sdk_predictor_specifications#

supported_inference_instance_types#

supported_training_instance_types#

task#

training_artifact_compression_type#

training_artifact_s3_data_type#

training_artifact_uri#

training_config_components#

training_config_rankings#

training_configs#

training_dependencies#

training_ecr_uri#

training_enable_network_isolation#

training_instance_type_variants#

training_metrics#

training_model_package_artifact_uri#

training_prepacked_script_uri#

training_prepacked_script_version#

training_script_uri#

training_supported#

training_volume_size#

url#

validation_supported#

class sagemaker.core.jumpstart.hub.interfaces.HubNotebookDocument(json_obj: Dict[str, Any], region: str)[source]#

Bases: HubDataHolderType

Data class for notebook type HubContentDocument from session.describe_hub_content().

SCHEMA_VERSION = '1.0.0'#

dependencies#

from_json(json_obj: Dict[str, Any]) → None[source]#

Sets fields in object based on json.

Parameters:: json_obj (Dict[str, Any]) – Dictionary representation of hub content description.

get_region() → str[source]#: Returns hub region.

get_schema_version() → str[source]#: Returns schema version.

notebook_location#

class sagemaker.core.jumpstart.hub.interfaces.HubS3StorageConfig(json_obj: Dict[str, Any])[source]#

Bases: HubDataHolderType

Data class for any dependencies related to hub content.

Includes scripts, model artifacts, datasets, or notebooks.

from_json(json_obj: Dict[str, Any] | None) → None[source]#

Sets fields in object based on json.

Parameters:: json_obj (Dict[str, Any]) – Dictionary representation of hub content description.

s3_output_path#

class sagemaker.core.jumpstart.hub.interfaces.HubSummary(json_obj: Dict[str, Any])[source]#

Bases: HubDataHolderType

Data class for the HubSummary from session.list_hubs()

creation_time#

from_json(json_obj: Dict[str, Any]) → None[source]#

Sets fields in object based on json.

Parameters:: json_obj (Dict[str, Any]) – Dictionary representation of hub description.

hub_arn#

hub_description#

hub_display_name#

hub_name#

hub_search_keywords#

hub_status#

last_modified_time#

class sagemaker.core.jumpstart.hub.interfaces.ImportHubResponse(json_obj: Dict[str, Any])[source]#

Bases: HubDataHolderType

Data class for the Hub from session.import_hub()

from_json(json_obj: Dict[str, Any]) → None[source]#

Sets fields in object based on json.

Parameters:: json_obj (Dict[str, Any]) – Dictionary representation of hub description.

hub_arn#

hub_content_arn#

class sagemaker.core.jumpstart.hub.interfaces.ListHubContentsResponse(json_obj: Dict[str, Any])[source]#

Bases: HubDataHolderType

Data class for the Hub from session.list_hub_contents()

from_json(json_obj: Dict[str, Any]) → None[source]#

Sets fields in object based on json.

Parameters:: json_obj (Dict[str, Any]) – Dictionary representation of hub description.

hub_content_summaries#

next_token#

class sagemaker.core.jumpstart.hub.interfaces.ListHubsResponse(json_obj: Dict[str, Any])[source]#

Bases: HubDataHolderType

Data class for the Hub from session.list_hubs()

from_json(json_obj: Dict[str, Any]) → None[source]#

Sets fields in object based on json.

Parameters:: json_obj (Dict[str, Any]) – Dictionary representation of session.list_hubs() response.

hub_summaries#

next_token#

class sagemaker.core.jumpstart.hub.interfaces.NotebookLocationUris(json_obj: Dict[str, Any])[source]#

Bases: HubDataHolderType

Data class for Notebook Location uri.

demo_notebook#

from_json(json_obj: str) → None[source]#

Sets fields in object based on json.

Parameters:: json_obj (Dict[str, Any]) – Dictionary representation of hub description.

model_deploy#

model_fit#