..
- Copyright (C) 2008-2015 EDF R&D
+ Copyright (C) 2008-2023 EDF R&D
This file is part of SALOME ADAO module.
Algorithme de calcul "*QuantileRegression*"
-------------------------------------------
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
Cet algorithme permet d'estimer les quantiles conditionnels de la distribution
-des paramètres d'état, exprimés à l'aide d'un modèle des variables observées. Ce
-sont donc les quantiles sur les variables observées qui vont permettre de
-déterminer les paramètres de modèles satisfaisant aux conditions de quantiles.
-
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
-
-.. index:: single: AlgorithmParameters
-.. index:: single: Background
-.. index:: single: Observation
-.. index:: single: ObservationOperator
-.. index:: single: Quantile
-.. index:: single: Minimizer
-.. index:: single: MaximumNumberOfSteps
-.. index:: single: CostDecrementTolerance
-.. index:: single: StoreSupplementaryCalculations
-
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
-
- Background
- *Commande obligatoire*. Elle définit le vecteur d'ébauche ou
- d'initialisation, noté précédemment :math:`\mathbf{x}^b`. Sa valeur est
- définie comme un objet de type "*Vector*" ou de type "*VectorSerie*".
-
- Observation
- *Commande obligatoire*. Elle définit le vecteur d'observation utilisé en
- assimilation de données ou en optimisation, et noté précédemment
- :math:`\mathbf{y}^o`. Sa valeur est définie comme un objet de type "*Vector*"
- ou de type "*VectorSerie*".
-
- ObservationOperator
- *Commande obligatoire*. Elle indique l'opérateur d'observation, noté
- précédemment :math:`H`, qui transforme les paramètres d'entrée
- :math:`\mathbf{x}` en résultats :math:`\mathbf{y}` qui sont à comparer aux
- observations :math:`\mathbf{y}^o`. Sa valeur est définie comme un objet de
- type "*Function*" ou de type "*Matrix*". Dans le cas du type "*Function*",
- différentes formes fonctionnelles peuvent être utilisées, comme décrit dans
- la section :ref:`section_ref_operator_requirements`. Si un contrôle
- :math:`U` est inclus dans le modèle d'observation, l'opérateur doit être
- appliqué à une paire :math:`(X,U)`.
-
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les options
-particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
-
-Les options de l'algorithme sont les suivantes:
-
- Quantile
- Cette clé permet de définir la valeur réelle du quantile recherché, entre 0
- et 1. La valeur par défaut est 0.5, correspondant à la médiane.
-
- Exemple : ``{"Quantile":0.5}``
-
- MaximumNumberOfSteps
- Cette clé indique le nombre maximum d'itérations possibles en optimisation
- itérative. Le défaut est 15000, qui est très similaire à une absence de
- limite sur les itérations. Il est ainsi recommandé d'adapter ce paramètre
- aux besoins pour des problèmes réels.
-
- Exemple : ``{"MaximumNumberOfSteps":100}``
-
- CostDecrementTolerance
- Cette clé indique une valeur limite, conduisant à arrêter le processus
- itératif d'optimisation lorsque la fonction coût décroît moins que cette
- tolérance au dernier pas. Le défaut est de 1.e-6, et il est recommandé de
- l'adapter aux besoins pour des problèmes réels.
-
- Exemple : ``{"CostDecrementTolerance":1.e-7}``
-
- StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme. 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. Les noms
- possibles sont dans la liste suivante : ["BMA", "CostFunctionJ",
- "CurrentState", "OMA", "OMB", "Innovation",
- "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
- "SimulatedObservationAtOptimum"].
-
- Exemple : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+des paramètres d'état, exprimés à l'aide d'un modèle des variables observées. Ce
+sont donc les quantiles sur les variables observées qui vont permettre de
+déterminer les paramètres de modèles satisfaisant aux conditions de quantiles.
-*Astuce pour cet algorithme :*
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
- Comme les commandes *"BackgroundError"* et *"ObservationError"* sont
- requises pour TOUS les algorithmes de calcul dans l'interface, vous devez
- fournir une valeur, malgré le fait que ces commandes ne sont pas requises
- pour cet algorithme, et ne seront pas utilisées. La manière la plus simple
- est de donner "1" comme un STRING pour les deux.
+.. include:: snippets/Background.rst
+
+.. include:: snippets/Observation.rst
+
+.. include:: snippets/ObservationOperator.rst
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. include:: snippets/BoundsWithNone.rst
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. include:: snippets/CostDecrementTolerance_6.rst
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/InitializationPoint.rst
- Analysis
- *Liste de vecteurs*. Chaque élément est un état optimal :math:`\mathbf{x}*`
- en optimisation ou une analyse :math:`\mathbf{x}^a` en assimilation de
- données.
+.. include:: snippets/MaximumNumberOfIterations.rst
- Exemple : ``Xa = ADD.get("Analysis")[-1]``
+.. include:: snippets/Quantile.rst
- CostFunctionJ
- *Liste de valeurs*. Chaque élément est une valeur de fonctionnelle d'écart
- :math:`J`.
+StoreSupplementaryCalculations
+ .. index:: single: StoreSupplementaryCalculations
- Exemple : ``J = ADD.get("CostFunctionJ")[:]``
+ *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. Leur
+ disponibilité implique, potentiellement, des calculs ou du stockage coûteux.
+ La valeur par défaut est donc une liste vide, aucune de ces variables n'étant
+ calculée et stockée par défaut (sauf les variables inconditionnelles). Les
+ noms possibles pour les variables supplémentaires sont dans la liste suivante
+ (la description détaillée de chaque variable nommée est donnée dans la suite
+ de cette documentation par algorithme spécifique, dans la sous-partie
+ "*Informations et variables disponibles à la fin de l'algorithme*") : [
+ "Analysis",
+ "BMA",
+ "CostFunctionJ",
+ "CostFunctionJb",
+ "CostFunctionJo",
+ "CurrentIterationNumber",
+ "CurrentState",
+ "Innovation",
+ "OMA",
+ "OMB",
+ "SimulatedObservationAtBackground",
+ "SimulatedObservationAtCurrentState",
+ "SimulatedObservationAtOptimum",
+ ].
+
+ Exemple :
+ ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
+
+*Astuce pour cet algorithme :*
+
+ Comme les commandes *"BackgroundError"* et *"ObservationError"* sont
+ requises pour TOUS les algorithmes de calcul dans l'interface graphique,
+ vous devez fournir une valeur, malgré le fait que ces commandes ne soient
+ pas nécessaires pour cet algorithme, et ne sont donc pas utilisées. La
+ manière la plus simple est de donner "1" comme un STRING pour les deux.
- CostFunctionJb
- *Liste de valeurs*. Chaque élément est une valeur de fonctionnelle d'écart
- :math:`J^b`, c'est-à-dire de la partie écart à l'ébauche.
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
- Exemple : ``Jb = ADD.get("CostFunctionJb")[:]``
+.. include:: snippets/Analysis.rst
- CostFunctionJo
- *Liste de valeurs*. Chaque élément est une valeur de fonctionnelle d'écart
- :math:`J^o`, c'est-à-dire de la partie écart à l'observation.
+.. include:: snippets/CostFunctionJ.rst
- Exemple : ``Jo = ADD.get("CostFunctionJo")[:]``
+.. include:: snippets/CostFunctionJb.rst
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/CostFunctionJo.rst
- BMA
- *Liste de vecteurs*. Chaque élément est un vecteur d'écart entre
- l'ébauche et l'état optimal.
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
- Exemple : ``bma = ADD.get("BMA")[-1]``
+.. include:: snippets/Analysis.rst
- CurrentState
- *Liste de vecteurs*. Chaque élément est un vecteur d'état courant utilisé
- au cours du déroulement de l'algorithme d'optimisation.
+.. include:: snippets/BMA.rst
- Exemple : ``Xs = ADD.get("CurrentState")[:]``
+.. include:: snippets/CostFunctionJ.rst
- Innovation
- *Liste de vecteurs*. Chaque élément est un vecteur d'innovation, qui est
- en statique l'écart de l'optimum à l'ébauche, et en dynamique l'incrément
- d'évolution.
+.. include:: snippets/CostFunctionJb.rst
- Exemple : ``d = ADD.get("Innovation")[-1]``
+.. include:: snippets/CostFunctionJo.rst
- OMA
- *Liste de vecteurs*. Chaque élément est un vecteur d'écart entre
- l'observation et l'état optimal dans l'espace des observations.
+.. include:: snippets/CurrentIterationNumber.rst
- Exemple : ``oma = ADD.get("OMA")[-1]``
+.. include:: snippets/CurrentState.rst
- OMB
- *Liste de vecteurs*. Chaque élément est un vecteur d'écart entre
- l'observation et l'état d'ébauche dans l'espace des observations.
+.. include:: snippets/Innovation.rst
- Exemple : ``omb = ADD.get("OMB")[-1]``
+.. include:: snippets/OMA.rst
- SimulatedObservationAtBackground
- *Liste de vecteurs*. Chaque élément est un vecteur d'observation simulé à
- partir de l'ébauche :math:`\mathbf{x}^b`.
+.. include:: snippets/OMB.rst
- Exemple : ``hxb = ADD.get("SimulatedObservationAtBackground")[-1]``
+.. include:: snippets/SimulatedObservationAtBackground.rst
- SimulatedObservationAtCurrentState
- *Liste de vecteurs*. Chaque élément est un vecteur observé à l'état courant,
- c'est-à-dire dans l'espace des observations.
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
- Exemple : ``Ys = ADD.get("SimulatedObservationAtCurrentState")[-1]``
+.. include:: snippets/SimulatedObservationAtOptimum.rst
- SimulatedObservationAtOptimum
- *Liste de vecteurs*. Chaque élément est un vecteur d'observation simulé à
- partir de l'analyse ou de l'état optimal :math:`\mathbf{x}^a`.
+.. ------------------------------------ ..
+.. _section_ref_algorithm_QuantileRegression_examples:
- Exemple : ``hxa = ADD.get("SimulatedObservationAtOptimum")[-1]``
+.. include:: snippets/Header2Algo06.rst
-Voir aussi
-++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo07.rst
-Références bibliographiques :
- - [Buchinsky98]_
- - [Cade03]_
- - [Koenker00]_
- - [Koenker01]_
- - [WikipediaQR]_
+- [Buchinsky98]_
+- [Cade03]_
+- [Koenker00]_
+- [Koenker01]_
+- [WikipediaQR]_
