.. include:: snippets/MaximumNumberOfSteps.rst
-Minimizer
- .. index:: single: Minimizer
-
- This key allows to choose the optimization minimizer. The default choice is
- "LBFGSB", and the possible ones are "LBFGSB" (nonlinear constrained
- minimizer, see [Byrd95]_, [Morales11]_ and [Zhu97]_), "TNC" (nonlinear
- constrained minimizer), "CG" (nonlinear unconstrained minimizer), "BFGS"
- (nonlinear unconstrained minimizer), "NCG" (Newton CG minimizer). It is
- strongly recommended to stay with the default.
-
- Example :
- ``{"Minimizer":"LBFGSB"}``
+.. include:: snippets/Minimizer_xDVAR.rst
.. include:: snippets/NumberOfSamplesForQuantiles.rst
.. ------------------------------------ ..
.. include:: snippets/Header2Algo03AdOp.rst
-Minimizer
- .. index:: single: Minimizer
-
- This key allows to choose the optimization minimizer. The default choice is
- "LBFGSB", and the possible ones are "LBFGSB" (nonlinear constrained
- minimizer, see [Byrd95]_, [Morales11]_ and [Zhu97]_), "TNC" (nonlinear
- constrained minimizer), "CG" (nonlinear unconstrained minimizer), "BFGS"
- (nonlinear unconstrained minimizer), "NCG" (Newton CG minimizer). It is
- strongly recommended to stay with the default.
-
- Example :
- ``{"Minimizer":"LBFGSB"}``
-
.. include:: snippets/BoundsWithNone.rst
.. include:: snippets/ConstrainedBy.rst
-.. include:: snippets/MaximumNumberOfSteps.rst
-
.. include:: snippets/CostDecrementTolerance.rst
.. include:: snippets/EstimationOf.rst
-.. include:: snippets/ProjectedGradientTolerance.rst
-
.. include:: snippets/GradientNormTolerance.rst
+.. include:: snippets/MaximumNumberOfSteps.rst
+
+.. include:: snippets/Minimizer_xDVAR.rst
+
+.. include:: snippets/ProjectedGradientTolerance.rst
+
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
.. ------------------------------------ ..
.. include:: snippets/Header2Algo03AdOp.rst
-Minimizer
- .. index:: single: Minimizer
-
- This key allows to choose the optimization minimizer. The default choice is
- "LBFGSB", and the possible ones are "LBFGSB" (nonlinear constrained
- minimizer, see [Byrd95]_, [Morales11]_ and [Zhu97]_), "TNC" (nonlinear
- constrained minimizer), "CG" (nonlinear unconstrained minimizer), "BFGS"
- (nonlinear unconstrained minimizer), "NCG" (Newton CG minimizer). It is
- strongly recommended to stay with the default.
+.. include:: snippets/BoundsWithNone.rst
- Example :
- ``{"Minimizer":"LBFGSB"}``
+.. include:: snippets/CostDecrementTolerance.rst
-.. include:: snippets/BoundsWithNone.rst
+.. include:: snippets/GradientNormTolerance.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
.. ------------------------------------ ..
.. include:: snippets/Header2Algo03AdOp.rst
-.. index:: single: NumberOfInsects
-.. index:: single: SwarmVelocity
-.. index:: single: GroupRecallRate
-.. index:: single: QualityCriterion
-.. index:: single: BoxBounds
-
.. include:: snippets/MaximumNumberOfSteps_50.rst
.. include:: snippets/MaximumNumberOfFunctionEvaluations.rst
.. include:: snippets/QualityCriterion.rst
-NumberOfInsects
- This key indicates the number of insects or particles in the swarm. The
- default is 100, which is a usual default for this algorithm.
-
- Example :
- ``{"NumberOfInsects":100}``
+.. include:: snippets/NumberOfInsects.rst
-SwarmVelocity
- This key indicates the part of the insect velocity which is imposed by the
- swarm. It is a positive floating point value. The default value is 1.
-
- Example :
- ``{"SwarmVelocity":1.}``
+.. include:: snippets/SwarmVelocity.rst
-GroupRecallRate
- This key indicates the recall rate at the best swarm insect. It is a
- floating point value between 0 and 1. The default value is 0.5.
+.. include:: snippets/GroupRecallRate.rst
- Example :
- ``{"GroupRecallRate":0.5}``
-
-BoxBounds
- This key allows to define upper and lower bounds for *increments* on every
- state variable being optimized (and not on state variables themselves).
- Bounds have to be given by a list of list of pairs of lower/upper bounds for
- each increment on variable, with extreme values every time there is no bound
- (``None`` is not allowed when there is no bound). This key is required and
- there is no default values.
-
- Example :
- ``{"BoxBounds":[[-0.5,0.5], [0.01,2.], [0.,1.e99], [-1.e99,1.e99]]}``
+.. include:: snippets/BoxBounds.rst
.. include:: snippets/SetSeed.rst
--- /dev/null
+.. index:: single: BoxBounds
+
+BoxBounds
+ *List of pairs of real values*. This key allows to define upper and lower
+ bounds for *increments* on every state variable being optimized (and not on
+ state variables themselves). Bounds have to be given by a list of list of
+ pairs of lower/upper bounds for each increment on variable, with extreme
+ values every time there is no bound (``None`` is not allowed when there is no
+ bound). This key is required and there is no default values.
+
+ Example :
+ ``{"BoxBounds":[[-0.5,0.5], [0.01,2.], [0.,1.e99], [-1.e99,1.e99]]}``
--- /dev/null
+.. index:: single: GroupRecallRate
+
+GroupRecallRate
+ *Real value*. This key indicates the recall rate at the best swarm insect. It
+ is a floating point value between 0 and 1. The default value is 0.5.
+
+ Example :
+ ``{"GroupRecallRate":0.5}``
--- /dev/null
+ .. index:: single: Minimizer
+
+Minimizer
+ *Predefined name*. This key allows to choose the optimization minimizer. The
+ default choice is "LBFGSB", and the possible ones are
+ "LBFGSB" (nonlinear constrained minimizer, see [Byrd95]_, [Morales11]_ and [Zhu97]_),
+ "TNC" (nonlinear constrained minimizer),
+ "CG" (nonlinear unconstrained minimizer),
+ "BFGS" (nonlinear unconstrained minimizer),
+ "NCG" (Newton CG minimizer).
+ It is strongly recommended to stay with the default.
+
+ Example :
+ ``{"Minimizer":"LBFGSB"}``
+
--- /dev/null
+.. index:: single: NumberOfInsects
+
+NumberOfInsects
+ *Integer value*. This key indicates the number of insects or particles in the
+ swarm. The default is 100, which is a usual default for this algorithm.
+
+ Example :
+ ``{"NumberOfInsects":100}``
--- /dev/null
+.. index:: single: SwarmVelocity
+
+SwarmVelocity
+ *Real value*. This key indicates the part of the insect velocity which is
+ imposed by the swarm, named "group velocity". It is a positive floating point
+ value. The default value is 1.
+
+ Example :
+ ``{"SwarmVelocity":1.}``
.. include:: snippets/MaximumNumberOfSteps.rst
-Minimizer
- .. index:: single: Minimizer
-
- 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). Il
- est fortement conseillé de conserver la valeur par défaut.
-
- Exemple :
- ``{"Minimizer":"LBFGSB"}``
+.. include:: snippets/Minimizer_xDVAR.rst
.. include:: snippets/NumberOfSamplesForQuantiles.rst
.. ------------------------------------ ..
.. include:: snippets/Header2Algo03AdOp.rst
-Minimizer
- .. index:: single: Minimizer
-
- 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). Il
- est fortement conseillé de conserver la valeur par défaut.
-
- Exemple :
- ``{"Minimizer":"LBFGSB"}``
-
.. include:: snippets/BoundsWithNone.rst
.. include:: snippets/ConstrainedBy.rst
-.. include:: snippets/MaximumNumberOfSteps.rst
-
.. include:: snippets/CostDecrementTolerance.rst
.. include:: snippets/EstimationOf.rst
-.. include:: snippets/ProjectedGradientTolerance.rst
-
.. include:: snippets/GradientNormTolerance.rst
+.. include:: snippets/MaximumNumberOfSteps.rst
+
+.. include:: snippets/Minimizer_xDVAR.rst
+
+.. include:: snippets/ProjectedGradientTolerance.rst
+
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
.. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
.. include:: snippets/CurrentIterationNumber.rst
+
.. include:: snippets/CurrentOptimum.rst
.. include:: snippets/CurrentState.rst
.. ------------------------------------ ..
.. include:: snippets/Header2Algo03AdOp.rst
-Minimizer
- .. index:: single: Minimizer
-
- 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/BoundsWithNone.rst
- Exemple :
- ``{"Minimizer":"LBFGSB"}``
+.. include:: snippets/CostDecrementTolerance.rst
-.. include:: snippets/BoundsWithNone.rst
+.. include:: snippets/GradientNormTolerance.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
.. ------------------------------------ ..
.. include:: snippets/Header2Algo03AdOp.rst
-.. index:: single: NumberOfInsects
-.. index:: single: SwarmVelocity
-.. index:: single: GroupRecallRate
-.. index:: single: QualityCriterion
-.. index:: single: BoxBounds
-
.. include:: snippets/MaximumNumberOfSteps_50.rst
.. include:: snippets/MaximumNumberOfFunctionEvaluations.rst
.. include:: snippets/QualityCriterion.rst
-NumberOfInsects
- Cette clé indique le nombre d'insectes ou de particules dans l'essaim. La
- valeur par défaut est 100, qui est une valeur par défaut usuelle pour cet
- algorithme.
-
- Exemple :
- ``{"NumberOfInsects":100}``
+.. include:: snippets/NumberOfInsects.rst
-SwarmVelocity
- Cette clé indique la part de la vitesse d'insecte qui est imposée par
- l'essaim. C'est une valeur réelle positive. Le défaut est de 1.
-
- Exemple :
- ``{"SwarmVelocity":1.}``
+.. include:: snippets/SwarmVelocity.rst
-GroupRecallRate
- Cette clé indique le taux de rappel vers le meilleur insecte de l'essaim.
- C'est une valeur réelle comprise entre 0 et 1. Le défaut est de 0.5.
+.. include:: snippets/GroupRecallRate.rst
- Exemple :
- ``{"GroupRecallRate":0.5}``
-
-BoxBounds
- Cette clé permet de définir des bornes supérieure et inférieure pour chaque
- incrément de variable d'état optimisée (et non pas chaque variable d'état
- elle-même). Les bornes doivent être données par une liste de liste de paires
- de bornes inférieure/supérieure pour chaque incrément de variable, avec une
- valeur extrême chaque fois qu'il n'y a pas de borne (``None`` n'est pas une
- valeur autorisée lorsqu'il n'y a pas de borne). Cette clé est requise et il
- n'y a pas de valeurs par défaut.
-
- Exemple :
- ``{"BoxBounds":[[-0.5,0.5], [0.01,2.], [0.,1.e99], [-1.e99,1.e99]]}``
+.. include:: snippets/BoxBounds.rst
.. include:: snippets/SetSeed.rst
--- /dev/null
+.. index:: single: BoxBounds
+
+BoxBounds
+ *Liste de paires de valeurs réelles*. Cette clé permet de définir des bornes
+ supérieure et inférieure pour chaque incrément de variable d'état optimisée
+ (et non pas chaque variable d'état elle-même). Les bornes doivent être
+ données par une liste de liste de paires de bornes inférieure/supérieure pour
+ chaque incrément de variable, avec une valeur extrême chaque fois qu'il n'y a
+ pas de borne (``None`` n'est pas une valeur autorisée lorsqu'il n'y a pas de
+ borne). Cette clé est requise et il n'y a pas de valeurs par défaut.
+
+ Exemple :
+ ``{"BoxBounds":[[-0.5,0.5], [0.01,2.], [0.,1.e99], [-1.e99,1.e99]]}``
--- /dev/null
+.. index:: single: GroupRecallRate
+
+GroupRecallRate
+ *Valeur réelle*. Cette clé indique le taux de rappel vers le meilleur insecte
+ de l'essaim. C'est une valeur réelle comprise entre 0 et 1. Le défaut est de
+ 0.5.
+
+ Exemple :
+ ``{"GroupRecallRate":0.5}``
--- /dev/null
+.. index:: single: Minimizer
+
+Minimizer
+ *Nom prédéfini*. 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).
+ Il est fortement conseillé de conserver la valeur par défaut.
+
+ Exemple :
+ ``{"Minimizer":"LBFGSB"}``
--- /dev/null
+.. index:: single: NumberOfInsects
+
+NumberOfInsects
+ *Valeur entière*. Cette clé indique le nombre d'insectes ou de particules
+ dans l'essaim. La valeur par défaut est 100, qui est une valeur par défaut
+ usuelle pour cet algorithme.
+
+ Exemple :
+ ``{"NumberOfInsects":100}``
--- /dev/null
+.. index:: single: SwarmVelocity
+
+SwarmVelocity
+ *Valeur réelle*. Cette clé indique la part de la vitesse d'insecte qui est
+ imposée par l'essaim, dite "vitesse de groupe". C'est une valeur réelle
+ positive. Le défaut est de 1.
+
+ Exemple :
+ ``{"SwarmVelocity":1.}``
