RunArgs: RunArgs Class

In DyfanJones/sagemaker-r-common: R6sagemaker lower level api calls

RunArgs Class

Description

Accepts parameters that correspond to ScriptProcessors.

Public fields

code

This can be an S3 URI or a local path to a file with the framework script to run

inputs

Input files for the processing job

outputs

Outputs for the processing job

arguments

A list of string arguments to be passed to a processing job

Methods

Public methods

• RunArgs$new()

• RunArgs$clone()

---

Method new()

An instance of this class is returned from the “get_run_args()“ method on processors, and is used for normalizing the arguments so that they can be passed to :class:'~sagemaker.workflow.steps.ProcessingStep'

Usage

RunArgs$new(code, inputs = NULL, outputs = NULL, arguments = NULL)

Arguments

code

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

inputs

(list[:class:'~sagemaker.processing.ProcessingInput']): Input files for the processing job. These must be provided as :class:'~sagemaker.processing.ProcessingInput' objects (default: None).

outputs

(list[:class:'~sagemaker.processing.ProcessingOutput']): Outputs for the processing job. These can be specified as either path strings or :class:'~sagemaker.processing.ProcessingOutput' objects (default: None).

arguments

(list[str]): A list of string arguments to be passed to a processing job (default: None).

---

Method clone()

The objects of this class are cloneable with this method.

Usage

RunArgs$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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