ImageUris: ImageUris Class

In DyfanJones/sagemaker-r-local: Sagemaker core classes, methods and functions

ImageUris Class

Description

Class to create and format sagemaker docker images stored in ECR

Methods

Public methods

• ImageUris$retrieve()

• ImageUris$get_training_image_uri()

• ImageUris$format()

• ImageUris$clone()

---

Method retrieve()

Retrieves the ECR URI for the Docker image matching the given arguments of inbuilt AWS Sagemaker models.

Usage

ImageUris$retrieve(
  framework,
  region,
  version = NULL,
  py_version = NULL,
  instance_type = NULL,
  accelerator_type = NULL,
  image_scope = NULL,
  container_version = NULL,
  distribution = NULL,
  base_framework_version = NULL,
  training_compiler_config = NULL,
  model_id = NULL,
  model_version = NULL,
  tolerate_vulnerable_model = FALSE,
  tolerate_deprecated_model = FALSE,
  sdk_version = NULL,
  inference_tool = NULL,
  serverless_inference_config = NULL
)

Arguments

framework

(str): The name of the framework or algorithm.

region

(str): The AWS region.

version

(str): The framework or algorithm version. This is required if there is more than one supported version for the given framework or algorithm.

py_version

(str): The Python version. This is required if there is more than one supported Python version for the given framework version.

instance_type

(str): The SageMaker instance type. For supported types, see https://aws.amazon.com/sagemaker/pricing/instance-types. This is required if there are different images for different processor types.

accelerator_type

(str): Elastic Inference accelerator type. For more, see https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html.

image_scope

(str): The image type, i.e. what it is used for. Valid values: "training", "inference", "eia". If “accelerator_type“ is set, “image_scope“ is ignored.

container_version

(str): the version of docker image

distribution

(dict): A dictionary with information on how to run distributed training (default: None).

base_framework_version

(str):

training_compiler_config

(:class:'~sagemaker.training_compiler.TrainingCompilerConfig'): A configuration class for the SageMaker Training Compiler (default: None).

model_id

(str): The JumpStart model ID for which to retrieve the image URI (default: None).

model_version

(str): The version of the JumpStart model for which to retrieve the image URI (default: None).

tolerate_vulnerable_model

(bool): “True“ if vulnerable versions of model specifications should be tolerated without an exception 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 versions of model specifications should be tolerated without an exception raised. If False, raises an exception if the version of the model is deprecated. (Default: False).

sdk_version

(str): the version of python-sdk that will be used in the image retrieval. (default: None).

inference_tool

(str): the tool that will be used to aid in the inference. Valid values: "neuron, None" (default: None).

serverless_inference_config

(sagemaker.core::ServerlessInferenceConfig): Specifies configuration related to serverless endpoint. Instance type is not provided in serverless inference. So this is used to determine processor type.

Returns

str: the ECR URI for the corresponding SageMaker Docker image.

---

Method get_training_image_uri()

Retrieves the image URI for training.

Usage

ImageUris$get_training_image_uri(
  region,
  framework,
  framework_version = NULL,
  py_version = NULL,
  image_uri = NULL,
  distribution = NULL,
  compiler_config = NULL,
  tensorflow_version = NULL,
  pytorch_version = NULL,
  instance_type = NULL
)

Arguments

region

(str): The AWS region to use for image URI.

framework

(str): The framework for which to retrieve an image URI.

framework_version

(str): The framework version for which to retrieve an image URI (default: NULL).

py_version

(str): The python version to use for the image (default: NULL).

image_uri

(str): If an image URI is supplied, it is returned (default: NULL).

distribution

(dict): A dictionary with information on how to run distributed training (default: NULL).

compiler_config

(:class:'~sagemaker.training_compiler.TrainingCompilerConfig'): A configuration class for the SageMaker Training Compiler (default: NULL).

tensorflow_version

(str): The version of TensorFlow to use. (default: NULL)

pytorch_version

(str): The version of PyTorch to use. (default: NULL)

instance_type

(str): The instance type to use. (default: NULL)

Returns

str: The image URI string.

---

Method format()

format class

Usage

ImageUris$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ImageUris$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-local documentation built on June 14, 2022, 10:32 p.m.