CompilationInput: CompilationInput

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

CompilationInput

Description

Create a class containing all the parameters. It can be used when calling “Model$compile_model()“

Public fields

target_instance_type

Identifies the device that you want to run your model after compilation

input_shape

Specifies the name and shape of the expected inputs for your trained model

output_path

Specifies where to store the compiled model

framework

The framework that is used to train the original model

framework_version

The version of the framework

compile_max_run

Timeout in seconds for compilation

tags

List of tags for labelling a compilation job

job_name

The name of the compilation job

target_platform_os

Target Platform OS

target_platform_arch

Target Platform Architecture

target_platform_accelerator

Target Platform Accelerator

compiler_options

Additional parameters for compiler

Methods

Public methods

• CompilationInput$new()

• CompilationInput$format()

• CompilationInput$clone()

---

Method new()

Initialize CompilationInput class

Usage

CompilationInput$new(
  target_instance_type = NULL,
  input_shape = NULL,
  output_path = NULL,
  framework = NULL,
  framework_version = NULL,
  compile_max_run = 15 * 60,
  tags = NULL,
  job_name = NULL,
  target_platform_os = NULL,
  target_platform_arch = NULL,
  target_platform_accelerator = NULL,
  compiler_options = NULL
)

Arguments

target_instance_type

(str): Identifies the device that you want to run your model after compilation, for example: ml_c5. For allowed strings see https://docs.aws.amazon.com/sagemaker/latest/dg/API_OutputConfig.html.

input_shape

(str): Specifies the name and shape of the expected inputs for your trained model in json dictionary form

output_path

(str): Specifies where to store the compiled model

framework

(str, optional): The framework that is used to train the original model. Allowed values: 'mxnet', 'tensorflow', 'keras', 'pytorch', 'onnx', 'xgboost' (default: None)

framework_version

(str, optional): The version of the framework (default: None)

compile_max_run

(int, optional): Timeout in seconds for compilation (default: 15 * 60). After this amount of time Amazon SageMaker Neo terminates the compilation job regardless of its current status.

tags

(list[dict], optional): List of tags for labelling a compilation job. For more, see https://docs.aws.amazon.com/sagemaker/latest/dg/API_Tag.html.

job_name

(str, optional): The name of the compilation job (default: None)

target_platform_os

(str, optional): Target Platform OS, for example: 'LINUX'. (default: None) For allowed strings see https://docs.aws.amazon.com/sagemaker/latest/dg/API_OutputConfig.html. It can be used instead of target_instance_family.

target_platform_arch

(str, optional): Target Platform Architecture, for example: 'X86_64'. (default: None) For allowed strings see https://docs.aws.amazon.com/sagemaker/latest/dg/API_OutputConfig.html. It can be used instead of target_instance_family.

target_platform_accelerator

(str, optional): Target Platform Accelerator, for example: 'NVIDIA'. (default: None) For allowed strings see https://docs.aws.amazon.com/sagemaker/latest/dg/API_OutputConfig.html. It can be used instead of target_instance_family.

compiler_options

(dict, optional): Additional parameters for compiler. (default: None) Compiler Options are TargetPlatform / target_instance_family specific. See https://docs.aws.amazon.com/sagemaker/latest/dg/API_OutputConfig.html for details.

---

Method format()

format class

Usage

CompilationInput$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

CompilationInput$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.