From ad835462644874fdbb569728b238721e25d4d47f Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Sun, 18 Nov 2012 22:18:11 +0100 Subject: [PATCH] Documenting default ProjectedGradientTolerance --- doc/reference.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/reference.rst b/doc/reference.rst index d316761..e1adc70 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -354,10 +354,10 @@ in the :ref:`genindex` or the :ref:`section_glossary`. recommended to adapt it the needs on real problems. ProjectedGradientTolerance - This key indicates a limit value, leading to stop successfully the - iterative optimization process when all the components of the projected - gradient are under this limit. It is only used for constrained algorithms. - The default is -1, that is the internal default of each algorithm, and it + This key indicates a limit value, leading to stop successfully the iterative + optimization process when all the components of the projected gradient are + under this limit. It is only used for constrained algorithms. The default is + -1, that is the internal default of each algorithm (generally 1.e-5), and it is not recommended to change it. GradientNormTolerance @@ -410,10 +410,10 @@ in the :ref:`genindex` or the :ref:`section_glossary`. recommended to adapt it the needs on real problems. ProjectedGradientTolerance - This key indicates a limit value, leading to stop successfully the - iterative optimization process when all the components of the projected - gradient are under this limit. It is only used for constrained algorithms. - The default is -1, that is the internal default of each algorithm, and it + This key indicates a limit value, leading to stop successfully the iterative + optimization process when all the components of the projected gradient are + under this limit. It is only used for constrained algorithms. The default is + -1, that is the internal default of each algorithm (generally 1.e-5), and it is not recommended to change it. GradientNormTolerance -- 2.39.2