@@ -515,8 +515,10 @@ def run_pre_training_bias(
515
515
wait (bool): Whether the call should wait until the job completes (default: True).
516
516
logs (bool): Whether to show the logs produced by the job.
517
517
Only meaningful when ``wait`` is True (default: True).
518
- job_name (str): Processing job name. If not specified, a name is composed of
519
- "Clarify-Pretraining-Bias" and current timestamp.
518
+ job_name (str): Processing job name. When ``job_name`` is not specified, if
519
+ ``job_name_prefix`` in :class:`SageMakerClarifyProcessor` specified, the job name
520
+ will be composed of ``job_name_prefix`` and current timestamp; otherwise use
521
+ "Clarify-Pretraining-Bias" as prefix.
520
522
kms_key (str): The ARN of the KMS key that is used to encrypt the
521
523
user code file (default: None).
522
524
experiment_config (dict[str, str]): Experiment management configuration.
@@ -561,23 +563,25 @@ def run_post_training_bias(
561
563
model_predicted_label_config (:class:`~sagemaker.clarify.ModelPredictedLabelConfig`):
562
564
Config of how to extract the predicted label from the model output.
563
565
methods (str or list[str]): Selector of a subset of potential metrics:
564
- ["`DPPL <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dppl.html>`_",
565
- "`DI <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-di.html>`_",
566
+ ["`DPPL <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dppl.html>`_"
567
+ , "`DI <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-di.html>`_",
566
568
"`DCA <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dca.html>`_",
567
569
"`DCR <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dcr.html>`_",
568
570
"`RD <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-rd.html>`_",
569
571
"`DAR <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dar.html>`_",
570
572
"`DRR <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-drr.html>`_",
571
573
"`AD <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-ad.html>`_",
572
- "`CDDPL <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-cddpl.html>`_",
573
- "`TE <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-te.html>`_",
574
+ "`CDDPL <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-cddpl.html>`_
575
+ ", " `TE <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-te.html>`_",
574
576
"`FT <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-ft.html>`_"].
575
577
Defaults to computing all.
576
578
wait (bool): Whether the call should wait until the job completes (default: True).
577
579
logs (bool): Whether to show the logs produced by the job.
578
580
Only meaningful when ``wait`` is True (default: True).
579
- job_name (str): Processing job name. If not specified, a name is composed of
580
- "Clarify-Posttraining-Bias" and current timestamp.
581
+ job_name (str): Processing job name. When ``job_name`` is not specified, if
582
+ ``job_name_prefix`` in :class:`SageMakerClarifyProcessor` specified, the job name
583
+ will be composed of ``job_name_prefix`` and current timestamp; otherwise use
584
+ "Clarify-Posttraining-Bias" as prefix.
581
585
kms_key (str): The ARN of the KMS key that is used to encrypt the
582
586
user code file (default: None).
583
587
experiment_config (dict[str, str]): Experiment management configuration.
@@ -640,23 +644,25 @@ def run_bias(
640
644
"`CDDL <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-cdd.html>`_"].
641
645
Defaults to computing all.
642
646
post_training_methods (str or list[str]): Selector of a subset of potential metrics:
643
- ["`DPPL <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dppl.html>`_",
644
- "`DI <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-di.html>`_",
647
+ ["`DPPL <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dppl.html>`_"
648
+ , "`DI <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-di.html>`_",
645
649
"`DCA <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dca.html>`_",
646
650
"`DCR <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dcr.html>`_",
647
651
"`RD <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-rd.html>`_",
648
652
"`DAR <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dar.html>`_",
649
653
"`DRR <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-drr.html>`_",
650
654
"`AD <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-ad.html>`_",
651
- "`CDDPL <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-cddpl.html>`_",
652
- "`TE <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-te.html>`_",
655
+ "`CDDPL <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-cddpl.html>`_
656
+ ", " `TE <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-te.html>`_",
653
657
"`FT <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-ft.html>`_"].
654
658
Defaults to computing all.
655
659
wait (bool): Whether the call should wait until the job completes (default: True).
656
660
logs (bool): Whether to show the logs produced by the job.
657
661
Only meaningful when ``wait`` is True (default: True).
658
- job_name (str): Processing job name. If not specified, a name is composed of
659
- "Clarify-Bias" and current timestamp.
662
+ job_name (str): Processing job name. When ``job_name`` is not specified, if
663
+ ``job_name_prefix`` in :class:`SageMakerClarifyProcessor` specified, the job name
664
+ will be composed of ``job_name_prefix`` and current timestamp; otherwise use
665
+ "Clarify-Bias" as prefix.
660
666
kms_key (str): The ARN of the KMS key that is used to encrypt the
661
667
user code file (default: None).
662
668
experiment_config (dict[str, str]): Experiment management configuration.
@@ -722,8 +728,10 @@ def run_explainability(
722
728
wait (bool): Whether the call should wait until the job completes (default: True).
723
729
logs (bool): Whether to show the logs produced by the job.
724
730
Only meaningful when ``wait`` is True (default: True).
725
- job_name (str): Processing job name. If not specified, a name is composed of
726
- "Clarify-Explainability" and current timestamp.
731
+ job_name (str): Processing job name. When ``job_name`` is not specified, if
732
+ ``job_name_prefix`` in :class:`SageMakerClarifyProcessor` specified, the job name
733
+ will be composed of ``job_name_prefix`` and current timestamp; otherwise use
734
+ "Clarify-Explainability" as prefix.
727
735
kms_key (str): The ARN of the KMS key that is used to encrypt the
728
736
user code file (default: None).
729
737
experiment_config (dict[str, str]): Experiment management configuration.
0 commit comments