From 215f2d904eda7b88bce1a3e904af6cdbe821ae59 Mon Sep 17 00:00:00 2001
From: Martin Reinecke <martin@mpa-garching.mpg.de>
Date: Wed, 9 Jan 2019 13:37:39 +0100
Subject: [PATCH] clarification
---
nifty5/minimization/scipy_minimizer.py | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/nifty5/minimization/scipy_minimizer.py b/nifty5/minimization/scipy_minimizer.py
index b3d1f88a6..2cb0ab28b 100644
--- a/nifty5/minimization/scipy_minimizer.py
+++ b/nifty5/minimization/scipy_minimizer.py
@@ -151,7 +151,8 @@ class ScipyCG(Minimizer):
"""Returns a ScipyMinimizer object carrying out the conjugate gradient
algorithm as implemented by SciPy.
- This class is probably superfluous and can be removed.
+ This class is only intended for double-checking NIFTy's own conjugate
+ gradient implementation and should not be used otherwise.
"""
def __init__(self, tol, maxiter):
if not dobj.is_numpy():
--
GitLab