TransformStep: Workflow TransformStep class

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

Workflow TransformStep class

Description

Transform step for workflow.

Super classes

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

Active bindings

arguments

The arguments dict that is used to call 'create_transform_job'. NOTE: The CreateTransformJob request is not quite the args list that workflow needs. TransformJobName and ExperimentConfig cannot be included in the arguments.

properties

A Properties object representing the DescribeTransformJobResponse data model.

Methods

Public methods

• TransformStep$new()

• TransformStep$to_request()

• TransformStep$clone()

Inherited methods

• sagemaker.workflow::Step$add_depends_on()

• sagemaker.workflow::Step$format()

• sagemaker.workflow::ConfigurableRetryStep$add_retry_policy()

---

Method new()

Constructs a TransformStep, given an 'Transformer' instance. In addition to the transformer instance, the other arguments are those that are supplied to the 'transform' method of the 'sagemaker.transformer.Transformer'.

Usage

TransformStep$new(
  name,
  transformer,
  inputs,
  display_name = NULL,
  description = NULL,
  cache_config = NULL,
  depends_on = NULL,
  retry_policies = NULL
)

Arguments

name

(str): The name of the transform step.

transformer

(Transformer): A 'sagemaker.transformer.Transformer' instance.

inputs

(TransformInput): A 'sagemaker.inputs.TransformInput' instance.

display_name

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

description

(str): The description of the transform step.

cache_config

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

depends_on

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

retry_policies

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

---

Method to_request()

Updates the dictionary with cache configuration.

Usage

TransformStep$to_request()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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