ProcessingStep: Workflow ProcessingStep Class

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

Workflow ProcessingStep Class

Description

Processing step for workflow.

Super classes

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

Active bindings

arguments

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

properties

A Properties object representing the DescribeProcessingJobResponse data model.

Methods

Public methods

• ProcessingStep$new()

• ProcessingStep$to_request()

• ProcessingStep$clone()

Inherited methods

• sagemaker.workflow::Step$add_depends_on()

• sagemaker.workflow::Step$format()

• sagemaker.workflow::ConfigurableRetryStep$add_retry_policy()

---

Method new()

Construct a ProcessingStep, given a 'Processor' instance. In addition to the processor instance, the other arguments are those that are supplied to the 'process' method of the 'sagemaker.processing.Processor'.

Usage

ProcessingStep$new(
  name,
  processor,
  display_name = NULL,
  description = NULL,
  inputs = NULL,
  outputs = NULL,
  job_arguments = NULL,
  code = NULL,
  property_files = NULL,
  cache_config = NULL,
  depends_on = NULL,
  retry_policies = NULL,
  kms_key = NULL
)

Arguments

name

(str): The name of the processing step.

processor

(Processor): A 'sagemaker.processing.Processor' instance.

display_name

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

description

(str): The description of the processing step.

inputs

(List[ProcessingInput]): A list of 'sagemaker.processing.ProcessorInput' instances. Defaults to 'None'.

outputs

(List[ProcessingOutput]): A list of 'sagemaker.processing.ProcessorOutput' instances. Defaults to 'None'.

job_arguments

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

code

(str): This can be an S3 URI or a local path to a file with the framework script to run. Defaults to 'None'.

property_files

(List[PropertyFile]): A list of property files that workflow looks for and resolves from the configured processing output list.

cache_config

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

depends_on

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

retry_policies

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

kms_key

(str): The ARN of the KMS key that is used to encrypt the user code file. Defaults to 'None'.

---

Method to_request()

Get the request structure for workflow service calls.

Usage

ProcessingStep$to_request()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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