Skip to content

Commit 43cdadd

Browse files
shinglyuShing Lyu
and
Shing Lyu
authored
documentation: Explain the ClarifyCheckStep and QualityCheckStep parameters (#4261)
* documentation: explain the ClarifyCheckStep and QualityCheckStep parameters * fix: remove trailing space --------- Co-authored-by: Shing Lyu <[email protected]>
1 parent 5c26c4e commit 43cdadd

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

src/sagemaker/workflow/clarify_check_step.py

+4
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,10 @@ def __init__(
168168
):
169169
"""Constructs a ClarifyCheckStep.
170170
171+
To understand the `skip_check`, `fail_on_violation`, `register_new_baseline`
172+
and `supplied_baseline_constraints` parameters, check the following documentation:
173+
https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html
174+
171175
Args:
172176
name (str): The name of the ClarifyCheckStep step.
173177
clarify_check_config (ClarifyCheckConfig): A ClarifyCheckConfig instance.

src/sagemaker/workflow/quality_check_step.py

+5
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,11 @@ def __init__(
135135
):
136136
"""Constructs a QualityCheckStep.
137137
138+
To understand the `skip_check`, `fail_on_violation`, `register_new_baseline`,
139+
`supplied_baseline_constraints` and `supplied_baseline_constraints` parameters,
140+
check the following documentation:
141+
https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html
142+
138143
Args:
139144
name (str): The name of the QualityCheckStep step.
140145
quality_check_config (QualityCheckConfig): A QualityCheckConfig instance.

0 commit comments

Comments
 (0)