add additional information to docstring

mention 'cg_tol' and 'cg_maxiter' will only be used when 'use_cg' is set to 'True' Signed-off-by: MrGranddy <[email protected]>
Project-MONAI · Jun 25, 2024 · 460c5e2 · 460c5e2
1 parent da02700
commit 460c5e2
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 5 deletions.
diff --git a/monai/data/ultrasound_confidence_map.py b/monai/data/ultrasound_confidence_map.py
@@ -43,8 +43,8 @@ class UltrasoundConfidenceMap:
         sink_mode (str, optional): Sink mode. Defaults to 'all'. If 'mask' is selected, a mask must be when calling
             the transform. Can be 'all', 'mid', 'min', or 'mask'.
         use_cg (bool, optional): Use Conjugate Gradient method for solving the linear system. Defaults to False.
-        cg_tol (float, optional): Tolerance for the Conjugate Gradient method. Defaults to 1e-6.
-        cg_maxiter (int, optional): Maximum number of iterations for the Conjugate Gradient method. Defaults to 200.
+        cg_tol (float, optional): Tolerance for the Conjugate Gradient method. Defaults to 1e-6. Will be used only if `use_cg` is True.
+        cg_maxiter (int, optional): Maximum number of iterations for the Conjugate Gradient method. Defaults to 200. Will be used only if `use_cg` is True.
     """
 
     def __init__(

diff --git a/monai/transforms/intensity/array.py b/monai/transforms/intensity/array.py
@@ -2800,8 +2800,8 @@ class UltrasoundConfidenceMapTransform(Transform):
         sink_mode (str, optional): Sink mode. Defaults to 'all'. If 'mask' is selected, a mask must be when
             calling the transform. Can be one of 'all', 'mid', 'min', 'mask'.
         use_cg (bool, optional): Use Conjugate Gradient method for solving the linear system. Defaults to False.
-        cg_tol (float, optional): Tolerance for the Conjugate Gradient method. Defaults to 1e-6.
-        cg_maxiter (int, optional): Maximum number of iterations for the Conjugate Gradient method. Defaults to 200.
+        cg_tol (float, optional): Tolerance for the Conjugate Gradient method. Defaults to 1e-6. Will be used only if `use_cg` is True.
+        cg_maxiter (int, optional): Maximum number of iterations for the Conjugate Gradient method. Defaults to 200. Will be used only if `use_cg` is True.
     """
 
     def __init__(

diff --git a/tests/test_ultrasound_confidence_map_transform.py b/tests/test_ultrasound_confidence_map_transform.py
@@ -698,7 +698,6 @@ def test_against_official_code_using_cg(self):
             )
             output = transform(input_img)
 
-
             assert_allclose(output, result_img, rtol=1e-2, atol=1e-2)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -698,7 +698,6 @@ def test_against_official_code_using_cg(self):
		)
		output = transform(input_img)


		assert_allclose(output, result_img, rtol=1e-2, atol=1e-2)


Expand Down