@@ -515,8 +515,10 @@ def run_pre_training_bias(
515515 wait (bool): Whether the call should wait until the job completes (default: True).
516516 logs (bool): Whether to show the logs produced by the job.
517517 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.
520522 kms_key (str): The ARN of the KMS key that is used to encrypt the
521523 user code file (default: None).
522524 experiment_config (dict[str, str]): Experiment management configuration.
@@ -561,23 +563,25 @@ def run_post_training_bias(
561563 model_predicted_label_config (:class:`~sagemaker.clarify.ModelPredictedLabelConfig`):
562564 Config of how to extract the predicted label from the model output.
563565 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>`_",
566568 "`DCA <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dca.html>`_",
567569 "`DCR <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dcr.html>`_",
568570 "`RD <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-rd.html>`_",
569571 "`DAR <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dar.html>`_",
570572 "`DRR <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-drr.html>`_",
571573 "`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>`_",
574576 "`FT <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-ft.html>`_"].
575577 Defaults to computing all.
576578 wait (bool): Whether the call should wait until the job completes (default: True).
577579 logs (bool): Whether to show the logs produced by the job.
578580 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.
581585 kms_key (str): The ARN of the KMS key that is used to encrypt the
582586 user code file (default: None).
583587 experiment_config (dict[str, str]): Experiment management configuration.
@@ -640,23 +644,25 @@ def run_bias(
640644 "`CDDL <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-cdd.html>`_"].
641645 Defaults to computing all.
642646 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>`_",
645649 "`DCA <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dca.html>`_",
646650 "`DCR <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dcr.html>`_",
647651 "`RD <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-rd.html>`_",
648652 "`DAR <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dar.html>`_",
649653 "`DRR <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-drr.html>`_",
650654 "`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>`_",
653657 "`FT <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-ft.html>`_"].
654658 Defaults to computing all.
655659 wait (bool): Whether the call should wait until the job completes (default: True).
656660 logs (bool): Whether to show the logs produced by the job.
657661 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.
660666 kms_key (str): The ARN of the KMS key that is used to encrypt the
661667 user code file (default: None).
662668 experiment_config (dict[str, str]): Experiment management configuration.
@@ -722,8 +728,10 @@ def run_explainability(
722728 wait (bool): Whether the call should wait until the job completes (default: True).
723729 logs (bool): Whether to show the logs produced by the job.
724730 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.
727735 kms_key (str): The ARN of the KMS key that is used to encrypt the
728736 user code file (default: None).
729737 experiment_config (dict[str, str]): Experiment management configuration.
0 commit comments