Skip to content

Commit 770e284

Browse files
committed
add more explainations to the doc
1 parent c1511a3 commit 770e284

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

doc/amazon_sagemaker_model_building_pipeline.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -980,7 +980,7 @@ Here is an example showing you how to configure a :class:`sagemaker.workflow.mon
980980
981981
transform_input_param = ParameterString(
982982
name="transform_input",
983-
default_value=f"s3://{bucket}/{prefix}/my-transform-input",
983+
default_value=f"s3://my-bucket/my-prefix/my-transform-input",
984984
)
985985
986986
# the resource configuration for the monitoring job
@@ -1017,10 +1017,12 @@ The following code sample demonstrates how to set up an on-demand batch transfor
10171017
transform_step_args=transform_arg,
10181018
monitor_configuration=data_quality_config,
10191019
check_job_configuration=job_config,
1020-
# no need to wait for the transform output.
1020+
# since data quality only looks at the inputs,
1021+
# so there is no need to wait for the transform output.
10211022
monitor_before_transform=True,
1022-
# if violation is detected in the monitoring, you can skip it
1023-
# and continue running batch transform
1023+
# if violation is detected in the monitoring, and you want to skip it
1024+
# and continue running batch transform, you can set fail_on_violation
1025+
# to false.
10241026
fail_on_violation=False,
10251027
supplied_baseline_statistics="s3://my-baseline-statistics.json",
10261028
supplied_baseline_constraints="s3://my-baseline-constraints.json",
@@ -1059,7 +1061,7 @@ The same example can be extended for model quality, bias, and feature attribute
10591061
output_s3_uri="s3://my-output",
10601062
# assume the model output is at column idx 10
10611063
inference_attribute="_c10",
1062-
# remember the first column is the ground truth.
1064+
# As pointed out previously, the first column is the ground truth.
10631065
ground_truth_attribute="_c0",
10641066
)
10651067
from sagemaker.workflow.monitor_batch_transform_step import MonitorBatchTransformStep
@@ -1069,7 +1071,8 @@ The same example can be extended for model quality, bias, and feature attribute
10691071
transform_step_args=transform_arg,
10701072
monitor_configuration=data_quality_config,
10711073
check_job_configuration=job_config,
1072-
# in fact, monitor_before_transform can not be true for model quality
1074+
# model quality job needs the transform outputs, therefore
1075+
# monitor_before_transform can not be true for model quality
10731076
monitor_before_transform=False,
10741077
fail_on_violation=True,
10751078
supplied_baseline_statistics="s3://my-baseline-statistics.json",

0 commit comments

Comments
 (0)