]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Minor documentation review corrections
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Fri, 24 Nov 2023 14:46:57 +0000 (15:46 +0100)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Fri, 24 Nov 2023 14:46:57 +0000 (15:46 +0100)
doc/en/ref_algorithm_EnsembleOfSimulationGenerationTask.rst
doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst
doc/en/ref_algorithm_SamplingTest.rst
doc/en/ref_sampling_requirements.rst
doc/en/snippets/SampleAsMinMaxSobolSequence.rst
doc/fr/ref_algorithm_EnsembleOfSimulationGenerationTask.rst
doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst
doc/fr/ref_algorithm_SamplingTest.rst
doc/fr/ref_sampling_requirements.rst
doc/fr/snippets/SampleAsMinMaxSobolSequence.rst

index fac12890d03af8861b5e1fef99d75649ead5db92..f5f962efbbcf68e5c9865b7504300df9b105b6a9 100644 (file)
@@ -48,12 +48,13 @@ to the chosen homogeneous collection of state vectors :math:`\mathbf{x}`
 
 The sampling of the states :math:`\mathbf{x}` can be given explicitly or under
 form of hypercubes, explicit or sampled according to classic distributions, or
-using Latin hypercube sampling (LHS). The computations are optimized according
-to the computer resources available and the options requested by the user. You
-can refer to the :ref:`section_ref_sampling_requirements` for an illustration
-of sampling. Beware of the size of the hypercube (and then to the number of
-computations) that can be reached, it can grow quickly to be quite large. When
-a state is not observable, a *"NaN"* value is returned.
+using Latin hypercube sampling (LHS) or Sobol sequences. The computations are
+optimized according to the computer resources available and the options
+requested by the user. You can refer to the
+:ref:`section_ref_sampling_requirements` for an illustration of sampling.
+Beware of the size of the hypercube (and then to the number of computations)
+that can be reached, it can grow quickly to be quite large. When a state is not
+observable, a *"NaN"* value is returned.
 
 To be visible by the user while reducing the risk of storage difficulties, the
 results of sampling or simulations has to be **explicitly** asked for using the
index d1f1231b83b4fdcfa23045dc7d646ad81acfd63d..6440498d918ace6aa912c8397a50140a97808cf5 100644 (file)
@@ -78,9 +78,9 @@ If the design of experiments is supplied, the sampling of the states
 :math:`\mathbf{x}` can be given as in the
 :ref:`section_ref_algorithm_EnsembleOfSimulationGenerationTask`, explicitly or
 under form of hypercubes, explicit or sampled according to classic
-distributions, or using Latin hypercube sampling (LHS). The computations are
-optimized according to the computer resources available and the options
-requested by the user. You can refer to the
+distributions, or using Latin hypercube sampling (LHS) or Sobol sequences. The
+computations are optimized according to the computer resources available and
+the options requested by the user. You can refer to the
 :ref:`section_ref_sampling_requirements` for an illustration of sampling.
 Beware of the size of the hypercube (and then to the number of computations)
 that can be reached, it can grow quickly to be quite large.
index 7984938a2b5cc66608abdf86182f837715e899ea..a3fd0dda6d7966a3bae2daa951cea194469c23f6 100644 (file)
@@ -42,12 +42,13 @@ to variations in the state :math:`\mathbf{x}` in particular.
 
 The sampling of the states :math:`\mathbf{x}` can be given explicitly or under
 form of hypercubes, explicit or sampled according to classic distributions, or
-using Latin hypercube sampling (LHS). The computations are optimized according
-to the computer resources available and the options requested by the user. You
-can refer to the :ref:`section_ref_sampling_requirements` for an illustration
-of sampling. Beware of the size of the hypercube (and then to the number of
-computations) that can be reached, it can grow quickly to be quite large. When
-a state is not observable, a *"NaN"* value is returned.
+using Latin hypercube sampling (LHS) or Sobol sequences. The computations are
+optimized according to the computer resources available and the options
+requested by the user. You can refer to the
+:ref:`section_ref_sampling_requirements` for an illustration of sampling.
+Beware of the size of the hypercube (and then to the number of computations)
+that can be reached, it can grow quickly to be quite large. When a state is not
+observable, a *"NaN"* value is returned.
 
 It is also possible to supply a set of simulations :math:`\mathbf{y}` already
 established elsewhere (so there's no explicit need for an operator
index 3ec4a46d3b1f9a96a55b4ed38de13e1288b547b0..e9a383fafa759cfe54c79c5c73d6684300fd9af5 100644 (file)
@@ -51,9 +51,9 @@ command set of an algorithm that requires it.
 
 The sampling of the states :math:`\mathbf{x}` can be provided explicitly or in
 the form of hypercubes, explicit or sampled according to common distributions,
-or using Latin Hypercube Sampling (LHS). Depending on the method, the sample
-will be included in the domain described by its bounds, or will be descriptive
-of the unbounded domain of state variables.
+or using Latin Hypercube Sampling (LHS) or Sobol sequences. Depending on the
+method, the sample will be included in the domain described by its bounds, or
+will be descriptive of the unbounded domain of state variables.
 
 These possible keywords are:
 
index 584f2f33915f9f127e4a07bfdd9a54e68e8afff6..0be97cddf73b2bb25561baa142ef7d17ab2772f9 100644 (file)
@@ -13,5 +13,8 @@ SampleAsMinMaxSobolSequence
   the Sobol sequence method. By nature, the points are included in the domain
   defined by the explicit bounds.
 
+  *Remark: it is required to have Scipy version 1.7.0 or higher to use this
+  sampling option.*
+
   Example :
   ``{"SampleAsMinMaxSobolSequence":[[0.,1.],[-1,3]]+[[2,11]]}`` for a state space of dimension 2 and 11 sampling points (there will be 16 points in practice).
index 72a66882a1377a8d6110b6ab4e673371e0c85141..8557f3aa3ac2cd38b342f5d8a15d265d663879e6 100644 (file)
@@ -50,11 +50,11 @@ variable stockable "*EnsembleOfStates*").
 L'échantillonnage des états :math:`\mathbf{x}` peut être fourni explicitement
 ou sous la forme d'hypercubes, explicites ou échantillonnés selon des
 distributions courantes, ou à l'aide d'un échantillonnage par hypercube latin
-(LHS). Les calculs sont optimisés selon les ressources informatiques
-disponibles et les options demandées par l'utilisateur. On pourra se reporter
-aux :ref:`section_ref_sampling_requirements` pour une illustration de
-l'échantillonnage. Attention à la taille de l'hypercube (et donc au nombre de
-calculs) qu'il est possible d'atteindre, elle peut rapidement devenir
+(LHS) ou par séquence de Sobol. Les calculs sont optimisés selon les ressources
+informatiques disponibles et les options demandées par l'utilisateur. On pourra
+se reporter aux :ref:`section_ref_sampling_requirements` pour une illustration
+de l'échantillonnage. Attention à la taille de l'hypercube (et donc au nombre
+de calculs) qu'il est possible d'atteindre, elle peut rapidement devenir
 importante. Lorsqu'un état n'est pas observable, une valeur *"NaN"* est
 retournée.
 
index c939d7c3314fb3e1ba177ca359b845f45b1e3d27..a441bbdd495b8cfecf739485e58a320c5bd42016 100644 (file)
@@ -82,11 +82,11 @@ Dans le cas où l'on fournit le plan d'expérience, l'échantillonnage des état
 :ref:`section_ref_algorithm_EnsembleOfSimulationGenerationTask`, explicitement
 ou sous la forme d'hypercubes, explicites ou échantillonnés selon des
 distributions courantes, ou à l'aide d'un échantillonnage par hypercube latin
-(LHS). Les calculs sont optimisés selon les ressources informatiques
-disponibles et les options demandées par l'utilisateur. On pourra se reporter
-aux :ref:`section_ref_sampling_requirements` pour une illustration de
-l'échantillonnage. Attention à la taille de l'hypercube (et donc au nombre de
-calculs) qu'il est possible d'atteindre, elle peut rapidement devenir
+(LHS) ou par séquence de Sobol. Les calculs sont optimisés selon les ressources
+informatiques disponibles et les options demandées par l'utilisateur. On pourra
+se reporter aux :ref:`section_ref_sampling_requirements` pour une illustration
+de l'échantillonnage. Attention à la taille de l'hypercube (et donc au nombre
+de calculs) qu'il est possible d'atteindre, elle peut rapidement devenir
 importante.
 
   .. _mop_determination:
index 12912c83ea098574ab8675dc0486d7e1d22ee121..ce16e3490afb7a3f50998b59e12b2446f881fcae 100644 (file)
@@ -44,11 +44,11 @@ aux variations de l'état :math:`\mathbf{x}` en particulier.
 L'échantillonnage des états :math:`\mathbf{x}` peut être fourni explicitement
 ou sous la forme d'hypercubes, explicites ou échantillonnés selon des
 distributions courantes, ou à l'aide d'un échantillonnage par hypercube latin
-(LHS). Les calculs sont optimisés selon les ressources informatiques
-disponibles et les options demandées par l'utilisateur. On pourra se reporter
-aux :ref:`section_ref_sampling_requirements` pour une illustration de
-l'échantillonnage. Attention à la taille de l'hypercube (et donc au nombre de
-calculs) qu'il est possible d'atteindre, elle peut rapidement devenir
+(LHS) ou par séquence de Sobol. Les calculs sont optimisés selon les ressources
+informatiques disponibles et les options demandées par l'utilisateur. On pourra
+se reporter aux :ref:`section_ref_sampling_requirements` pour une illustration
+de l'échantillonnage. Attention à la taille de l'hypercube (et donc au nombre
+de calculs) qu'il est possible d'atteindre, elle peut rapidement devenir
 importante. Lorsqu'un état n'est pas observable, une valeur *"NaN"* est
 retournée.
 
index 8fad23b1b34cb8a421e16337e51aabd9543c279e..7b90bf6fd9e4f245e8c81e530b04de82972ed6a9 100644 (file)
@@ -54,8 +54,9 @@ mots-clés dédiés dans le jeu de commandes d'un algorithme qui le nécessite.
 L'échantillonnage des états :math:`\mathbf{x}` peut être fourni explicitement
 ou sous la forme d'hypercubes, explicites ou échantillonnés selon des
 distributions courantes, ou à l'aide d'un échantillonnage par hypercube latin
-(LHS). Selon la méthode, l'échantillon sera inclus dans le domaine décrit par
-ses bornes ou sera descriptif du domaine non borné des variables d'état.
+(LHS) ou par séquence de Sobol. Selon la méthode, l'échantillon sera inclus
+dans le domaine décrit par ses bornes ou sera descriptif du domaine non borné
+des variables d'état.
 
 Ces mots-clés possibles sont les suivants :
 
index 6882b189988ccaaa62753391d73ee8e4816ebbef..2bd61bd32bd3b7b5c93c75639090099d21fc01fc 100644 (file)
@@ -15,5 +15,8 @@ SampleAsMinMaxSobolSequence
   méthode de séquences de Sobol. Par nature, les points sont inclus dans le
   domaine défini par les bornes explicites.
 
+  *Remarque : il est nécessaire de disposer de Scipy en version supérieure à
+  1.7.0 pour utiliser cette option échantillonnage.*
+
   Exemple :
   ``{"SampleAsMinMaxSobolSequence":[[0.,1.],[-1,3]]+[[2,11]]}`` pour un espace d'état de dimension 2 et au moins 11 points d'échantillonnage (il y aura 16 points en pratique).