doc/en/ref_algorithm_QuantileRegression.rst

   1 ..
   2    Copyright (C) 2008-2014 EDF R&D
   3
   4    This file is part of SALOME ADAO module.
   5
   6    This library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    This library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with this library; if not, write to the Free Software
  18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19
  20    See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21
  22    Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
  23
  24 .. index:: single: QuantileRegression
  25 .. _section_ref_algorithm_QuantileRegression:
  26
  27 Calculation algorithm "*QuantileRegression*"
  28 --------------------------------------------
  29
  30 Description
  31 +++++++++++
  32
  33 This algorithm allows to estimate the conditional quantiles of the state
  34 parameters distribution, expressed with a model of the observed variables. These
  35 are then the quantiles on the observed variables which will allow to determine
  36 the model parameters that satisfy to the quantiles conditions.
  37
  38 Optional and required commands
  39 ++++++++++++++++++++++++++++++
  40
  41 .. index:: single: Background
  42 .. index:: single: Observation
  43 .. index:: single: ObservationOperator
  44 .. index:: single: Quantile
  45 .. index:: single: Minimizer
  46 .. index:: single: MaximumNumberOfSteps
  47 .. index:: single: CostDecrementTolerance
  48 .. index:: single: StoreInternalVariables
  49 .. index:: single: StoreSupplementaryCalculations
  50
  51 The general required commands, available in the editing user interface, are the
  52 following:
  53
  54   Background
  55     *Required command*. This indicates the background or initial vector used,
  56     previously noted as :math:`\mathbf{x}^b`. Its value is defined as a
  57     "*Vector*" or a *VectorSerie*" type object.
  58
  59   Observation
  60     *Required command*. This indicates the observation vector used for data
  61     assimilation or optimization, previously noted as :math:`\mathbf{y}^o`. It
  62     is defined as a "*Vector*" or a *VectorSerie* type object.
  63
  64   ObservationOperator
  65     *Required command*. This indicates the observation operator, previously
  66     noted :math:`H`, which transforms the input parameters :math:`\mathbf{x}` to
  67     results :math:`\mathbf{y}` to be compared to observations
  68     :math:`\mathbf{y}^o`. Its value is defined as a "*Function*" type object or
  69     a "*Matrix*" type one. In the case of "*Function*" type, different
  70     functional forms can be used, as described in the section
  71     :ref:`section_ref_operator_requirements`. If there is some control :math:`U`
  72     included in the observation, the operator has to be applied to a pair
  73     :math:`(X,U)`.
  74
  75 The general optional commands, available in the editing user interface, are
  76 indicated in :ref:`section_ref_assimilation_keywords`. In particular, the
  77 optional command "*AlgorithmParameters*" allows to choose the specific options,
  78 described hereafter, of the algorithm. See
  79 :ref:`section_ref_options_AlgorithmParameters` for the good use of this command.
  80
  81 The options of the algorithm are the following:
  82
  83   Quantile
  84     This key allows to define the real value of the desired quantile, between
  85     0 and 1. The default is 0.5, corresponding to the median.
  86
  87     Example : ``{"Quantile":0.5}``
  88
  89   MaximumNumberOfSteps
  90     This key indicates the maximum number of iterations allowed for iterative
  91     optimization. The default is 15000, which is very similar to no limit on
  92     iterations. It is then recommended to adapt this parameter to the needs on
  93     real problems.
  94
  95     Example : ``{"MaximumNumberOfSteps":100}``
  96
  97   CostDecrementTolerance
  98     This key indicates a limit value, leading to stop successfully the
  99     iterative optimization process when the cost function or the surrogate
 100     decreases less than this tolerance at the last step. The default is 1.e-6,
 101     and it is recommended to adapt it to the needs on real problems.
 102
 103     Example : ``{"CostDecrementTolerance":1.e-7}``
 104
 105   StoreInternalVariables
 106     This Boolean key allows to store default internal variables, mainly the
 107     current state during iterative optimization process. Be careful, this can be
 108     a numerically costly choice in certain calculation cases. The default is
 109     "False".
 110
 111     Example : ``{"StoreInternalVariables":True}``
 112
 113   StoreSupplementaryCalculations
 114     This list indicates the names of the supplementary variables that can be
 115     available at the end of the algorithm. It involves potentially costly
 116     calculations or memory consumptions. The default is a void list, none of
 117     these variables being calculated and stored by default. The possible names
 118     are in the following list: ["BMA", "OMA", "OMB", "Innovation"].
 119
 120     Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
 121
 122 *Tips for this algorithm:*
 123
 124     As the *"BackgroundError"* and *"ObservationError"* commands are required
 125     for ALL the calculation algorithms in the interface, you have to provide a
 126     value, even if these commands are not required for this algorithm, and will
 127     not be used. The simplest way is to give "1" as a STRING for both.
 128
 129 See also
 130 ++++++++
 131
 132 Bibliographical references:
 133   - [Buchinsky98]_
 134   - [Cade03]_
 135   - [Koenker00]_
 136   - [Koenker01]_
 137   - [WikipediaQR]_