CompilationStep: CompilationStep class

In DyfanJones/sagemaker-r-workflow: sagemaker pipeline and workflows

CompilationStep class

Description

Compilation step for workflow.

Super classes

sagemaker.workflow::Entity -> sagemaker.workflow::Step -> sagemaker.workflow::ConfigurableRetryStep -> CompilationStep

Active bindings

arguments

The arguments dict that is used to call 'create_compilation_job'. NOTE: The CreateTrainingJob request is not quite the args list that workflow needs. The TrainingJobName and ExperimentConfig attributes cannot be included.

properties

A Properties object representing the DescribeTrainingJobResponse data model.

Methods

Public methods

• CompilationStep$new()

• CompilationStep$to_request()

• CompilationStep$clone()

Inherited methods

• sagemaker.workflow::Step$add_depends_on()

• sagemaker.workflow::Step$format()

• sagemaker.workflow::ConfigurableRetryStep$add_retry_policy()

---

Method new()

Construct a CompilationStep. Given an 'EstimatorBase' and a 'sagemaker.model.Model' instance construct a CompilationStep. In addition to the estimator and Model instances, the other arguments are those that are supplied to the 'compile_model' method of the 'sagemaker.model.Model.compile_model'.

Usage

CompilationStep$new(
  name,
  estimator,
  model,
  inputs = NULL,
  job_arguments = NULL,
  depends_on = NULL,
  retry_policies = NULL,
  display_name = NULL,
  description = NULL,
  cache_config = NULL
)

Arguments

name

(str): The name of the compilation step.

estimator

(EstimatorBase): A 'sagemaker.estimator.EstimatorBase' instance.

model

(Model): A 'sagemaker.model.Model' instance.

inputs

(CompilationInput): A 'sagemaker.inputs.CompilationInput' instance. Defaults to 'None'.

job_arguments

(List[str]): A list of strings to be passed into the processing job. Defaults to 'None'.

depends_on

(List[str] or List[Step]): A list of step names or step instances this 'sagemaker.workflow.steps.CompilationStep' depends on

retry_policies

(List[RetryPolicy]): A list of retry policy

display_name

(str): The display name of the compilation step.

description

(str): The description of the compilation step.

cache_config

(CacheConfig): A 'sagemaker.workflow.steps.CacheConfig' instance.

---

Method to_request()

Updates the dictionary with cache configuration.

Usage

CompilationStep$to_request()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

CompilationStep$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-workflow documentation built on April 3, 2022, 11:28 p.m.