QualityCheckStep: QualityCheckStep class

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

QualityCheckStep class

Description

QualityCheck step for workflow.

Super classes

sagemaker.workflow::Entity -> sagemaker.workflow::Step -> QualityCheckStep

Active bindings

arguments

The arguments dict that is used to define the QualityCheck step.

properties

A Properties object representing the output parameters of the QualityCheck step.

Methods

Public methods

• QualityCheckStep$new()

• QualityCheckStep$to_request()

• QualityCheckStep$clone()

Inherited methods

• sagemaker.workflow::Step$add_depends_on()

• sagemaker.workflow::Step$format()

---

Method new()

Constructs a QualityCheckStep.

Usage

QualityCheckStep$new(
  name,
  quality_check_config,
  check_job_config,
  skip_check = FALSE,
  register_new_baseline = FALSE,
  model_package_group_name = NULL,
  supplied_baseline_statistics = NULL,
  supplied_baseline_constraints = NULL,
  display_name = NULL,
  description = NULL,
  cache_config = NULL,
  depends_on = NULL
)

Arguments

name

(str): The name of the QualityCheckStep step.

quality_check_config

(QualityCheckConfig): A QualityCheckConfig instance.

check_job_config

(CheckJobConfig): A CheckJobConfig instance.

skip_check

(bool or PipelineNonPrimitiveInputTypes): Whether the check should be skipped (default: False).

register_new_baseline

(bool or PipelineNonPrimitiveInputTypes): Whether the new baseline should be registered (default: False).

model_package_group_name

(str or PipelineNonPrimitiveInputTypes): The name of a registered model package group, among which the baseline will be fetched from the latest approved model (default: None).

supplied_baseline_statistics

(str or PipelineNonPrimitiveInputTypes): The S3 path to the supplied statistics object representing the statistics JSON file which will be used for drift to check (default: None).

supplied_baseline_constraints

(str or PipelineNonPrimitiveInputTypes): The S3 path to the supplied constraints object representing the constraints JSON file which will be used for drift to check (default: None).

display_name

(str): The display name of the QualityCheckStep step (default: None).

description

(str): The description of the QualityCheckStep step (default: None).

cache_config

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

depends_on

(List[str] or List[Step]): A list of step names or step instances this 'sagemaker.workflow.steps.QualityCheckStep' depends on (default: None).

---

Method to_request()

Updates the dictionary with cache configuration etc.

Usage

QualityCheckStep$to_request()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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