Skip to content

Commit 621e70e

Browse files
authored
Changed method description per AWS request (#3098)
1 parent 56452f1 commit 621e70e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/sagemaker/clarify.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -827,7 +827,7 @@ def run_pre_training_bias(
827827
"`TVD <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-data-bias-metric-total-variation-distance.html>`_",
828828
"`KS <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-data-bias-metric-kolmogorov-smirnov.html>`_",
829829
"`CDDL <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-data-bias-metric-cddl.html>`_"].
830-
Defaults to computing all.
830+
Defaults to str "all" to run all metrics if left unspecified.
831831
wait (bool): Whether the call should wait until the job completes (default: True).
832832
logs (bool): Whether to show the logs produced by the job.
833833
Only meaningful when ``wait`` is True (default: True).
@@ -906,7 +906,7 @@ def run_post_training_bias(
906906
"`CDDPL <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-cddpl.html>`_
907907
", "`TE <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-te.html>`_",
908908
"`FT <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-ft.html>`_"].
909-
Defaults to computing all.
909+
Defaults to str "all" to run all metrics if left unspecified.
910910
wait (bool): Whether the call should wait until the job completes (default: True).
911911
logs (bool): Whether to show the logs produced by the job.
912912
Only meaningful when ``wait`` is True (default: True).
@@ -989,7 +989,7 @@ def run_bias(
989989
"`TVD <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-data-bias-metric-total-variation-distance.html>`_",
990990
"`KS <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-data-bias-metric-kolmogorov-smirnov.html>`_",
991991
"`CDDL <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-data-bias-metric-cddl.html>`_"].
992-
Defaults to computing all.
992+
Defaults to str "all" to run all metrics if left unspecified.
993993
post_training_methods (str or list[str]): Selector of a subset of potential metrics:
994994
["`DPPL <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-dppl.html>`_"
995995
, "`DI <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-di.html>`_",
@@ -1002,7 +1002,7 @@ def run_bias(
10021002
"`CDDPL <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-cddpl.html>`_
10031003
", "`TE <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-te.html>`_",
10041004
"`FT <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-post-training-bias-metric-ft.html>`_"].
1005-
Defaults to computing all.
1005+
Defaults to str "all" to run all metrics if left unspecified.
10061006
wait (bool): Whether the call should wait until the job completes (default: True).
10071007
logs (bool): Whether to show the logs produced by the job.
10081008
Only meaningful when ``wait`` is True (default: True).

0 commit comments

Comments
 (0)