PipeLineExperimentConfig: Workflow PipelineExperimentConfig class

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

Workflow PipelineExperimentConfig class

Description

Experiment config for SageMaker pipeline.

Super class

sagemaker.workflow::Entity -> PipelineExperimentConfig

Methods

Public methods

• PipelineExperimentConfig$new()

• PipelineExperimentConfig$to_request()

• PipelineExperimentConfig$clone()

Inherited methods

• sagemaker.workflow::Entity$format()

---

Method new()

Create a PipelineExperimentConfig

Usage

PipelineExperimentConfig$new(experiment_name, trial_name)

Arguments

experiment_name

(Union[str, Parameter, ExecutionVariable, Expression]): the name of the experiment that will be created.

trial_name

(Union[str, Parameter, ExecutionVariable, Expression]): the name of the trial that will be created.

Examples

# Use pipeline name as the experiment name and pipeline execution id as the trial name::
PipelineExperimentConfig$new(
     ExecutionVariables$PIPELINE_NAME, ExecutionVariables$PIPELINE_EXECUTION_ID)
# Use a customized experiment name and pipeline execution id as the trial name::
PipelineExperimentConfig$new(
     'MyExperiment', ExecutionVariables$PIPELINE_EXECUTION_ID)

---

Method to_request()

Returns: the request structure.

Usage

PipelineExperimentConfig$to_request()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

PipelineExperimentConfig$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## ------------------------------------------------
## Method `PipelineExperimentConfig$new`
## ------------------------------------------------

# Use pipeline name as the experiment name and pipeline execution id as the trial name::
PipelineExperimentConfig$new(
     ExecutionVariables$PIPELINE_NAME, ExecutionVariables$PIPELINE_EXECUTION_ID)
# Use a customized experiment name and pipeline execution id as the trial name::
PipelineExperimentConfig$new(
     'MyExperiment', ExecutionVariables$PIPELINE_EXECUTION_ID)

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