Documentation improvements and post analysis

[modules/adao.git] / doc / fr / ref_algorithm_NonLinearLeastSquares.rst

diff --git a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst
index e88d7034a8303106049fa61ff6ae9c1afc8d45cb..4bc6c604271811874a361fadd722ce7e4d814ec2 100644 (file)
--- a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst
+++ b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst
@@ -1,5 +1,5 @@
 ..
-   Copyright (C) 2008-2020 EDF R&D
+   Copyright (C) 2008-2021 EDF R&D
 
    This file is part of SALOME ADAO module.
 
@@ -57,40 +57,31 @@ comportement lors de l'optimisation.
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo03AdOp.rst
 
-Minimizer
-  .. index:: single: Minimizer
+.. include:: snippets/BoundsWithNone.rst
 
-  Cette clé permet de changer le minimiseur pour l'optimiseur. Le choix par
-  défaut est "LBFGSB", et les choix possibles sont "LBFGSB" (minimisation non
-  linéaire sous contraintes, voir [Byrd95]_, [Morales11]_ et [Zhu97]_), "TNC"
-  (minimisation non linéaire sous contraintes), "CG" (minimisation non
-  linéaire sans contraintes), "BFGS" (minimisation non linéaire sans
-  contraintes), "NCG" (minimisation de type gradient conjugué de Newton), "LM"
-  (minimisation non linéaire de type Levenberg-Marquard). Il est fortement
-  conseillé de conserver la valeur par défaut.
+.. include:: snippets/CostDecrementTolerance.rst
 
-  Exemple :
-  ``{"Minimizer":"LBFGSB"}``
+.. include:: snippets/GradientNormTolerance.rst
 
-.. include:: snippets/BoundsWithNone.rst
+.. include:: snippets/InitializationPoint.rst
 
 .. include:: snippets/MaximumNumberOfSteps.rst
 
-.. include:: snippets/CostDecrementTolerance.rst
+.. include:: snippets/Minimizer_xDVAR.rst
 
 .. include:: snippets/ProjectedGradientTolerance.rst
 
-.. include:: snippets/GradientNormTolerance.rst
 
 StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
-  Cette liste indique les noms des variables supplémentaires qui peuvent être
-  disponibles à la fin de l'algorithme, si elles sont initialement demandées par
-  l'utilisateur. Cela implique potentiellement des calculs ou du stockage
-  coûteux. La valeur par défaut est une liste vide, aucune de ces variables
-  n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
-  Les noms possibles sont dans la liste suivante : [
+  *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+  qui peuvent être disponibles au cours du déroulement ou à la fin de
+  l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+  implique potentiellement des calculs ou du stockage coûteux. La valeur par
+  défaut est une liste vide, aucune de ces variables n'étant calculée et
+  stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+  sont dans la liste suivante : [
   "Analysis",
   "BMA",
   "CostFunctionJ",
@@ -99,6 +90,7 @@ StoreSupplementaryCalculations
   "CostFunctionJbAtCurrentOptimum",
   "CostFunctionJo",
   "CostFunctionJoAtCurrentOptimum",
+  "CurrentIterationNumber",
   "CurrentOptimum",
   "CurrentState",
   "IndexOfOptimum",
@@ -118,7 +110,7 @@ StoreSupplementaryCalculations
 *Astuce pour cet algorithme :*
 
     Comme la commande *"BackgroundError"* est requise pour TOUS les algorithmes
-    de calcul dans l'interface graphique ADAO EFICAS, vous devez fournir une
+    de calcul dans l'interface graphique EFICAS d'ADAO, vous devez fournir une
     valeur, malgré le fait que cette commande ne soit pas nécessaire pour cet
     algorithme, et n'est donc pas utilisée. La manière la plus simple est de
     donner "1" comme un STRING.
@@ -153,6 +145,8 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
 
+.. include:: snippets/CurrentIterationNumber.rst
+
 .. include:: snippets/CurrentOptimum.rst
 
 .. include:: snippets/CurrentState.rst
@@ -178,6 +172,8 @@ StoreSupplementaryCalculations
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo09.rst
 
+.. include:: scripts/simple_NonLinearLeastSquares.rst
+
 .. literalinclude:: scripts/simple_NonLinearLeastSquares.py
 
 .. include:: snippets/Header2Algo10.rst