CacheConfig: Workflow CacheConfig class

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

Workflow CacheConfig class

Description

Configuration class to enable caching in pipeline workflow.

Public fields

enable_caching

To enable step caching.

expire_after

If step caching is enabled, a timeout also needs to defined.

Active bindings

config

Configures caching in pipeline steps.

Methods

Public methods

• CacheConfig$new()

• CacheConfig$format()

• CacheConfig$clone()

---

Method new()

Initialize Workflow CacheConfig If caching is enabled, the pipeline attempts to find a previous execution of a step that was called with the same arguments. Step caching only considers successful execution. If a successful previous execution is found, the pipeline propagates the values from previous execution rather than recomputing the step. When multiple successful executions exist within the timeout period, it uses the result for the most recent successful execution.

Usage

CacheConfig$new(enable_caching = FALSE, expire_after = NULL)

Arguments

enable_caching

(bool): To enable step caching. Defaults to 'FALSE'.

expire_after

(str): If step caching is enabled, a timeout also needs to defined. It defines how old a previous execution can be to be considered for reuse. Value should be an ISO 8601 duration string. Defaults to 'NULL'.

---

Method format()

format class

Usage

CacheConfig$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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