sagemaker-core 1.0.62__py3-none-any.whl → 2.3.1__py3-none-any.whl

sagemaker/core/inputs.py

@@ -0,0 +1,366 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+"""Amazon SageMaker channel configurations for S3 data sources and file system data sources"""
+from __future__ import absolute_import, print_function
+
+from typing import Union, Optional, List
+import attr
+
+from sagemaker.core.helper.pipeline_variable import PipelineVariable
+
+FILE_SYSTEM_TYPES = ["FSxLustre", "EFS"]
+FILE_SYSTEM_ACCESS_MODES = ["ro", "rw"]
+
+
+class TrainingInput(object):
+    """Amazon SageMaker channel configurations for S3 data sources.
+
+    Attributes:
+        config (dict[str, dict]): A SageMaker ``DataSource`` referencing
+            a SageMaker ``S3DataSource``.
+    """
+
+    def __init__(
+        self,
+        s3_data: Union[str, PipelineVariable],
+        distribution: Optional[Union[str, PipelineVariable]] = None,
+        compression: Optional[Union[str, PipelineVariable]] = None,
+        content_type: Optional[Union[str, PipelineVariable]] = None,
+        record_wrapping: Optional[Union[str, PipelineVariable]] = None,
+        s3_data_type: Union[str, PipelineVariable] = "S3Prefix",
+        instance_groups: Optional[List[Union[str, PipelineVariable]]] = None,
+        input_mode: Optional[Union[str, PipelineVariable]] = None,
+        attribute_names: Optional[List[Union[str, PipelineVariable]]] = None,
+        target_attribute_name: Optional[Union[str, PipelineVariable]] = None,
+        shuffle_config: Optional["ShuffleConfig"] = None,
+        hub_access_config: Optional[dict] = None,
+        model_access_config: Optional[dict] = None,
+    ):
+        r"""Create a definition for input data used by an SageMaker training job.
+
+        See AWS documentation on the ``CreateTrainingJob`` API for more details
+        on the parameters.
+
+        Args:
+            s3_data (str or PipelineVariable): Defines the location of S3 data to train on.
+            distribution (str or PipelineVariable): Valid values: ``'FullyReplicated'``,
+                ``'ShardedByS3Key'`` (default: ``'FullyReplicated'``).
+            compression (str or PipelineVariable): Valid values: ``'Gzip'``, ``None``
+                (default: None). This is used only in Pipe input mode.
+            content_type (str or PipelineVariable): MIME type of the input data
+                (default: None).
+            record_wrapping (str or PipelineVariable): Valid values: 'RecordIO'
+                (default: None).
+            s3_data_type (str or PipelineVariable): Valid values: ``'S3Prefix'``,
+                ``'ManifestFile'``, ``'AugmentedManifestFile'``.
+                If ``'S3Prefix'``, ``s3_data`` defines a prefix of s3 objects to train on.
+                All objects with s3 keys beginning with ``s3_data`` will be used to train.
+                If ``'ManifestFile'`` or ``'AugmentedManifestFile'``,
+                then ``s3_data`` defines a
+                single S3 manifest file or augmented manifest file respectively,
+                listing the S3 data to train on. Both the ManifestFile and
+                AugmentedManifestFile formats are described at `S3DataSource
+                <https://docs.aws.amazon.com/sagemaker/latest/dg/API_S3DataSource.html>`_
+                in the `Amazon SageMaker API reference`.
+            instance_groups (list[str] or list[PipelineVariable]): Optional. A list of
+                instance group names in string format that you specified while configuring
+                a heterogeneous cluster using the :class:`sagemaker.instance_group.InstanceGroup`.
+                S3 data will be sent to all instance groups in the specified list.
+                For instructions on how to use InstanceGroup objects
+                to configure a heterogeneous cluster
+                through the SageMaker generic and framework estimator classes, see
+                `Train Using a Heterogeneous Cluster
+                <https://docs.aws.amazon.com/sagemaker/latest/dg/train-heterogeneous-cluster.html>`_
+                in the *Amazon SageMaker developer guide*.
+                (default: None)
+            input_mode (str or PipelineVariable): Optional override for this channel's input mode
+                (default: None). By default, channels will use the input mode defined on
+                ``sagemaker.estimator.EstimatorBase.input_mode``, but they will ignore
+                that setting if this parameter is set.
+
+                    * None - Amazon SageMaker will use the input mode specified in the ``Estimator``
+                    * 'File' - Amazon SageMaker copies the training dataset from the S3 location to
+                        a local directory.
+                    * 'Pipe' - Amazon SageMaker streams data directly from S3 to the container via
+                        a Unix-named pipe.
+                    * 'FastFile' - Amazon SageMaker streams data from S3 on demand instead of
+                        downloading the entire dataset before training begins.
+
+            attribute_names (list[str] or list[PipelineVariable]): A list of one or more attribute
+                names to use that are found in a specified AugmentedManifestFile.
+            target_attribute_name (str or PipelineVariable): The name of the attribute will be
+                predicted (classified) in a SageMaker AutoML job. It is required if the input is
+                for SageMaker AutoML job.
+            shuffle_config (sagemaker.inputs.ShuffleConfig): If specified this configuration enables
+                shuffling on this channel. See the SageMaker API documentation for more info:
+                https://docs.aws.amazon.com/sagemaker/latest/dg/API_ShuffleConfig.html
+            hub_access_config (dict): Specify the HubAccessConfig of a
+                Model Reference for which a training job is being created for.
+            model_access_config (dict): For models that require a Model Access Config, specify True
+                or False for to indicate whether model terms of use have been accepted.
+                The `accept_eula` value must be explicitly defined as `True` in order to
+                accept the end-user license agreement (EULA) that some
+                models require. (Default: None).
+        """
+        self.config = {
+            "DataSource": {"S3DataSource": {"S3DataType": s3_data_type, "S3Uri": s3_data}}
+        }
+
+        if not (target_attribute_name or distribution):
+            distribution = "FullyReplicated"
+
+        if distribution is not None:
+            self.config["DataSource"]["S3DataSource"]["S3DataDistributionType"] = distribution
+
+        if compression is not None:
+            self.config["CompressionType"] = compression
+        if content_type is not None:
+            self.config["ContentType"] = content_type
+        if record_wrapping is not None:
+            self.config["RecordWrapperType"] = record_wrapping
+        if instance_groups is not None:
+            self.config["DataSource"]["S3DataSource"]["InstanceGroupNames"] = instance_groups
+        if input_mode is not None:
+            self.config["InputMode"] = input_mode
+        if attribute_names is not None:
+            self.config["DataSource"]["S3DataSource"]["AttributeNames"] = attribute_names
+        if target_attribute_name is not None:
+            self.config["TargetAttributeName"] = target_attribute_name
+        if shuffle_config is not None:
+            self.config["ShuffleConfig"] = {"Seed": shuffle_config.seed}
+        self.add_hub_access_config(hub_access_config)
+        self.add_model_access_config(model_access_config)
+
+    def add_hub_access_config(self, hub_access_config=None):
+        """Add Hub Access Config to the channel's configuration.
+
+        Args:
+            hub_access_config (dict): The HubAccessConfig to be added to the
+            channel's configuration.
+        """
+        if hub_access_config is not None:
+            self.config["DataSource"]["S3DataSource"]["HubAccessConfig"] = hub_access_config
+
+    def add_model_access_config(self, model_access_config=None):
+        """Add Model Access Config to the channel's configuration.
+
+        Args:
+            model_access_config (dict): Whether model terms of use have been accepted.
+        """
+        if model_access_config is not None:
+            self.config["DataSource"]["S3DataSource"]["ModelAccessConfig"] = model_access_config
+
+
+class ShuffleConfig(object):
+    """For configuring channel shuffling using a seed.
+
+    For more detail, see the AWS documentation:
+    https://docs.aws.amazon.com/sagemaker/latest/dg/API_ShuffleConfig.html
+    """
+
+    def __init__(self, seed):
+        """Create a ShuffleConfig.
+
+        Args:
+            seed (long): the long value used to seed the shuffled sequence.
+        """
+        self.seed = seed
+
+
+@attr.s
+class CreateModelInput(object):
+    """A class containing parameters which can be used to create a SageMaker Model
+
+    Parameters:
+        instance_type (str): type or EC2 instance will be used for model deployment.
+        accelerator_type (str): elastic inference accelerator type.
+    """
+
+    instance_type: str = attr.ib(default=None)
+    accelerator_type: str = attr.ib(default=None)
+
+
+@attr.s
+class TransformInput(object):
+    """Creates a class containing parameters for configuring input data for a batch tramsform job.
+
+    It can be used when calling ``sagemaker.transformer.Transformer.transform()``
+
+    Args:
+        data (str): The S3 location of the input data that the model can consume.
+        data_type (str): The data type for a batch transform job.
+            (default: ``'S3Prefix'``)
+        content_type (str): The multi-purpose internet email extension (MIME) type of the data.
+            (default: None)
+        compression_type (str): If your transform data is compressed, specify the compression type.
+            Valid values: ``'Gzip'``, ``None``
+            (default: None)
+        split_type (str): The method to use to split the transform job's data files into smaller
+            batches.
+            Valid values: ``'Line'``, ``RecordIO``, ``'TFRecord'``, None
+            (default: None)
+        input_filter (str): A JSONPath expression for selecting a portion of the input data to pass
+            to the algorithm. For example, you can use this parameter to exclude fields, such as an
+            ID column, from the input. If you want SageMaker to pass the entire input dataset to the
+            algorithm, accept the default value ``$``. For more information on batch transform data
+            processing, input, join, and output, see
+            `Associate Prediction Results with Input Records
+            <https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html?>`_
+            in the *Amazon SageMaker developer guide*.
+            Example value: ``$``. For more information about valid values for this parameter, see
+            `JSONPath Operators
+            <https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators>`_
+            in the *Amazon SageMaker developer guide*.
+            (default: ``$``)
+        output_filter (str): A JSONPath expression for selecting a portion of the joined dataset to
+            save in the output file for a batch transform job. If you want SageMaker to store the
+            entire input dataset in the output file, leave the default value, $. If you specify
+            indexes that aren't within the dimension size of the joined dataset, you get an error.
+            Example value: ``$``. For more information about valid values for this parameter, see
+            `JSONPath Operators
+            <https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators>`_
+            in the *Amazon SageMaker developer guide*.
+            (default: ``$``)
+        join_source (str): Specifies the source of the data to join with the transformed data.
+            The default value is ``None``, which specifies not to join the input with the
+            transformed data. If you want the batch transform job to join the original input data
+            with the transformed data, set to ``Input``.
+            Valid values: ``None``, ``Input``
+            (default: None)
+        model_client_config (dict): Configures the timeout and maximum number of retries for
+            processing a transform job invocation.
+
+                * ``'InvocationsTimeoutInSeconds'`` (int) - The timeout value in seconds for an
+                  invocation request. The default value is 600.
+                * ``'InvocationsMaxRetries'`` (int) - The maximum number of retries when invocation
+                  requests are failing.
+
+            (default: ``{600,3}``)
+        batch_data_capture_config (dict): The dict is an object of `BatchDataCaptureConfig
+            <https://sagemaker.readthedocs.io/en/stable/api/utility/inputs.html#sagemaker.inputs.BatchDataCaptureConfig>`_
+            and specifies configuration related to batch transform job
+            for use with Amazon SageMaker Model Monitoring. For more information,
+            see `Capture data from batch transform job
+            <https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture-batch.html>`_
+            in the *Amazon SageMaker developer guide*.
+            (default: None)
+    """
+
+    data: str = attr.ib()
+    data_type: str = attr.ib(default="S3Prefix")
+    content_type: str = attr.ib(default=None)
+    compression_type: str = attr.ib(default=None)
+    split_type: str = attr.ib(default=None)
+    input_filter: str = attr.ib(default=None)
+    output_filter: str = attr.ib(default=None)
+    join_source: str = attr.ib(default=None)
+    model_client_config: dict = attr.ib(default=None)
+    batch_data_capture_config: dict = attr.ib(default=None)
+
+
+class FileSystemInput(object):
+    """Amazon SageMaker channel configurations for file system data sources.
+
+    Attributes:
+        config (dict[str, dict]): A Sagemaker File System ``DataSource``.
+    """
+
+    def __init__(
+        self,
+        file_system_id,
+        file_system_type,
+        directory_path,
+        file_system_access_mode="ro",
+        content_type=None,
+    ):
+        """Create a new file system input used by an SageMaker training job.
+
+        Args:
+            file_system_id (str): An Amazon file system ID starting with 'fs-'.
+            file_system_type (str): The type of file system used for the input.
+                Valid values: 'EFS', 'FSxLustre'.
+            directory_path (str): Absolute or normalized path to the root directory (mount point) in
+                the file system.
+                Reference: https://docs.aws.amazon.com/efs/latest/ug/mounting-fs.html and
+                https://docs.aws.amazon.com/fsx/latest/LustreGuide/mount-fs-auto-mount-onreboot.html
+            file_system_access_mode (str): Permissions for read and write.
+                Valid values: 'ro' or 'rw'. Defaults to 'ro'.
+        """
+
+        if file_system_type not in FILE_SYSTEM_TYPES:
+            raise ValueError(
+                "Unrecognized file system type: %s. Valid values: %s."
+                % (file_system_type, ", ".join(FILE_SYSTEM_TYPES))
+            )
+
+        if file_system_access_mode not in FILE_SYSTEM_ACCESS_MODES:
+            raise ValueError(
+                "Unrecognized file system access mode: %s. Valid values: %s."
+                % (file_system_access_mode, ", ".join(FILE_SYSTEM_ACCESS_MODES))
+            )
+
+        self.config = {
+            "DataSource": {
+                "FileSystemDataSource": {
+                    "FileSystemId": file_system_id,
+                    "FileSystemType": file_system_type,
+                    "DirectoryPath": directory_path,
+                    "FileSystemAccessMode": file_system_access_mode,
+                }
+            }
+        }
+
+        if content_type:
+            self.config["ContentType"] = content_type
+
+
+class BatchDataCaptureConfig(object):
+    """Configuration object passed in when create a batch transform job.
+
+    Specifies configuration related to batch transform job data capture for use with
+    Amazon SageMaker Model Monitoring
+    """
+
+    def __init__(
+        self,
+        destination_s3_uri: str,
+        kms_key_id: str = None,
+        generate_inference_id: bool = None,
+    ):
+        """Create new BatchDataCaptureConfig
+
+        Args:
+            destination_s3_uri (str): S3 Location to store the captured data
+            kms_key_id (str): The KMS key to use when writing to S3.
+                KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of a KMS key,
+                or alias of a KMS key. The KmsKeyId is applied to all outputs.
+                (default: None)
+            generate_inference_id (bool): Flag to generate an inference id
+                (default: None)
+        """
+        self.destination_s3_uri = destination_s3_uri
+        self.kms_key_id = kms_key_id
+        self.generate_inference_id = generate_inference_id
+
+    def _to_request_dict(self):
+        """Generates a request dictionary using the parameters provided to the class."""
+        batch_data_capture_config = {
+            "DestinationS3Uri": self.destination_s3_uri,
+        }
+
+        if self.kms_key_id is not None:
+            batch_data_capture_config["KmsKeyId"] = self.kms_key_id
+        if self.generate_inference_id is not None:
+            batch_data_capture_config["GenerateInferenceId"] = self.generate_inference_id
+
+        return batch_data_capture_config

sagemaker/core/instance_group.py

@@ -0,0 +1,61 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+"""Defines the InstanceGroup class that configures a heterogeneous cluster."""
+from __future__ import absolute_import
+
+
+class InstanceGroup(object):
+    """The class to create instance groups for a heterogeneous cluster."""
+
+    def __init__(
+        self,
+        instance_group_name=None,
+        instance_type=None,
+        instance_count=None,
+    ):
+        """It initializes an ``InstanceGroup`` instance.
+
+        You can create instance group object of the ``InstanceGroup`` class
+        by specifying the instance group configuration arguments.
+
+        For instructions on how to use InstanceGroup objects
+        to configure a heterogeneous cluster
+        through the SageMaker generic and framework estimator classes, see
+        `Train Using a Heterogeneous Cluster
+        <https://docs.aws.amazon.com/sagemaker/latest/dg/train-heterogeneous-cluster.html>`_
+        in the *Amazon SageMaker developer guide*.
+
+        Args:
+            instance_group_name (str): The name of the instance group.
+            instance_type (str): The instance type to use in the instance group.
+            instance_count (int): The number of instances to use in the instance group.
+
+                .. tip::
+
+                    For more information about available values for the arguments,
+                    see `InstanceGroup
+                    <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_InstanceGroup.html>`_
+                    API in the `Amazon SageMaker API reference`.
+
+        """
+        self.instance_group_name = instance_group_name
+        self.instance_type = instance_type
+        self.instance_count = instance_count
+
+    def _to_request_dict(self):
+        """Generates a request dictionary using the parameters provided to the class."""
+        return {
+            "InstanceGroupName": self.instance_group_name,
+            "InstanceType": self.instance_type,
+            "InstanceCount": self.instance_count,
+        }

sagemaker/core/instance_types.py

@@ -0,0 +1,164 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+"""Accessors to retrieve instance types."""
+
+from __future__ import absolute_import
+
+import logging
+from typing import List, Optional
+
+from sagemaker.core.jumpstart import utils as jumpstart_utils
+from sagemaker.core.jumpstart import artifacts
+from sagemaker.core.jumpstart.constants import DEFAULT_JUMPSTART_SAGEMAKER_SESSION
+from sagemaker.core.jumpstart.enums import JumpStartModelType
+from sagemaker.core.helper.session_helper import Session
+
+logger = logging.getLogger(__name__)
+
+
+def retrieve_default(
+    region: Optional[str] = None,
+    model_id: Optional[str] = None,
+    model_version: Optional[str] = None,
+    hub_arn: Optional[str] = None,
+    scope: Optional[str] = None,
+    tolerate_vulnerable_model: bool = False,
+    tolerate_deprecated_model: bool = False,
+    sagemaker_session: Session = DEFAULT_JUMPSTART_SAGEMAKER_SESSION,
+    training_instance_type: Optional[str] = None,
+    model_type: JumpStartModelType = JumpStartModelType.OPEN_WEIGHTS,
+    config_name: Optional[str] = None,
+) -> str:
+    """Retrieves the default instance type for the model matching the given arguments.
+
+    Args:
+        region (str): The AWS Region for which to retrieve the default instance type.
+            Defaults to ``None``.
+        model_id (str): The model ID of the model for which to
+            retrieve the default instance type. (Default: None).
+        model_version (str): The version of the model for which to retrieve the
+            default instance type. (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).
+        training_instance_type (str): In the case of a model fine-tuned on SageMaker, the training
+            instance type used for the training job that produced the fine-tuned weights.
+            Optionally supply this to get a inference instance type conditioned
+            on the training instance, to ensure compatability of training artifact to inference
+            instance. (Default: None).
+        config_name (Optional[str]): Name of the JumpStart Model config to apply. (Default: None).
+    Returns:
+        str: The default instance type to use for the model.
+
+    Raises:
+        ValueError: If the combination of arguments specified is not supported.
+    """
+    if not jumpstart_utils.is_jumpstart_model_input(model_id, model_version):
+        raise ValueError(
+            "Must specify JumpStart `model_id` and `model_version` when retrieving instance types."
+        )
+
+    if scope is None:
+        raise ValueError("Must specify scope for instance types.")
+
+    return artifacts._retrieve_default_instance_type(
+        model_id,
+        model_version,
+        scope,
+        hub_arn,
+        region,
+        tolerate_vulnerable_model,
+        tolerate_deprecated_model,
+        sagemaker_session=sagemaker_session,
+        training_instance_type=training_instance_type,
+        model_type=model_type,
+        config_name=config_name,
+    )
+
+
+def retrieve(
+    region: Optional[str] = None,
+    model_id: Optional[str] = None,
+    model_version: Optional[str] = None,
+    hub_arn: Optional[str] = None,
+    scope: Optional[str] = None,
+    tolerate_vulnerable_model: bool = False,
+    tolerate_deprecated_model: bool = False,
+    sagemaker_session: Session = DEFAULT_JUMPSTART_SAGEMAKER_SESSION,
+    training_instance_type: Optional[str] = None,
+) -> List[str]:
+    """Retrieves the supported training instance types for the model matching the given arguments.
+
+    Args:
+        region (str): The AWS Region for which to retrieve the supported instance types.
+            Defaults to ``None``.
+        model_id (str): The model ID of the model for which to
+            retrieve the supported instance types. (Default: None).
+        model_version (str): The version of the model for which to retrieve the
+            supported instance types. (Default: None).
+        hub_arn (str): The arn of the SageMaker Hub for which to retrieve
+            model details from. (Default: None).
+        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).
+        training_instance_type (str): In the case of a model fine-tuned on SageMaker, the training
+            instance type used for the training job that produced the fine-tuned weights.
+            Optionally supply this to get a inference instance type conditioned
+            on the training instance, to ensure compatability of training artifact to inference
+            instance. (Default: None).
+
+    Returns:
+        list: The supported instance types to use for the model.
+
+    Raises:
+        ValueError: If the combination of arguments specified is not supported.
+    """
+    if not jumpstart_utils.is_jumpstart_model_input(model_id, model_version):
+        raise ValueError(
+            "Must specify JumpStart `model_id` and `model_version` when retrieving instance types."
+        )
+
+    if scope is None:
+        raise ValueError("Must specify scope for instance types.")
+
+    return artifacts._retrieve_instance_types(
+        model_id=model_id,
+        model_version=model_version,
+        scope=scope,
+        hub_arn=hub_arn,
+        region=region,
+        tolerate_vulnerable_model=tolerate_vulnerable_model,
+        tolerate_deprecated_model=tolerate_deprecated_model,
+        sagemaker_session=sagemaker_session,
+        training_instance_type=training_instance_type,
+    )

sagemaker/core/instance_types_gpu_info.py

@@ -0,0 +1,43 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+"""Accessors to retrieve instance types GPU info."""
+from __future__ import absolute_import
+
+import json
+import os
+from typing import Dict
+
+
+def retrieve(region: str) -> Dict[str, Dict[str, int]]:
+    """Retrieves instance types GPU info of the given region.
+
+    Args:
+        region (str): The AWS region.
+
+    Returns:
+        dict[str, dict[str, int]]: A dictionary that contains instance types as keys
+                                   and GPU info as values or empty dictionary if the
+                                   config for the given region is not found.
+
+    Raises:
+        ValueError: If no config found.
+    """
+    config_path = os.path.join(
+        os.path.dirname(__file__), "image_uri_config", "instance_gpu_info.json"
+    )
+    try:
+        with open(config_path) as f:
+            instance_types_gpu_info_config = json.load(f)
+        return instance_types_gpu_info_config.get(region, {})
+    except FileNotFoundError:
+        raise ValueError("Could not find instance types gpu info.")

sagemaker/core/interactive_apps/__init__.py

@@ -0,0 +1,41 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+"""Classes for starting/accessing apps hosted on Amazon SageMaker Studio."""
+
+from __future__ import absolute_import
+
+from enum import Enum
+
+from sagemaker.core.interactive_apps.base_interactive_app import (  # noqa: F401
+    BaseInteractiveApp,
+)
+from sagemaker.core.interactive_apps.detail_profiler_app import (  # noqa: F401
+    DetailProfilerApp,
+)
+from sagemaker.core.interactive_apps.tensorboard import (  # noqa: F401
+    TensorBoardApp,
+)
+
+
+class SupportedInteractiveAppTypes(Enum):
+    """SupportedInteractiveAppTypes indicates which apps are supported."""
+
+    TENSORBOARD = 1
+
+
+__all__ = [
+    "BaseInteractiveApp",
+    "DetailProfilerApp",
+    "SupportedInteractiveAppTypes",
+    "TensorBoardApp",
+]