From cdcd3ed7d0735257d29f346a0809c30faa475218 Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Fri, 24 Nov 2023 15:46:57 +0100 Subject: [PATCH] Minor documentation review corrections --- ...algorithm_EnsembleOfSimulationGenerationTask.rst | 13 +++++++------ ...algorithm_MeasurementsOptimalPositioningTask.rst | 6 +++--- doc/en/ref_algorithm_SamplingTest.rst | 13 +++++++------ doc/en/ref_sampling_requirements.rst | 6 +++--- doc/en/snippets/SampleAsMinMaxSobolSequence.rst | 3 +++ ...algorithm_EnsembleOfSimulationGenerationTask.rst | 10 +++++----- ...algorithm_MeasurementsOptimalPositioningTask.rst | 10 +++++----- doc/fr/ref_algorithm_SamplingTest.rst | 10 +++++----- doc/fr/ref_sampling_requirements.rst | 5 +++-- doc/fr/snippets/SampleAsMinMaxSobolSequence.rst | 3 +++ 10 files changed, 44 insertions(+), 35 deletions(-) diff --git a/doc/en/ref_algorithm_EnsembleOfSimulationGenerationTask.rst b/doc/en/ref_algorithm_EnsembleOfSimulationGenerationTask.rst index fac1289..f5f962e 100644 --- a/doc/en/ref_algorithm_EnsembleOfSimulationGenerationTask.rst +++ b/doc/en/ref_algorithm_EnsembleOfSimulationGenerationTask.rst @@ -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 diff --git a/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst b/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst index d1f1231..6440498 100644 --- a/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst +++ b/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst @@ -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. diff --git a/doc/en/ref_algorithm_SamplingTest.rst b/doc/en/ref_algorithm_SamplingTest.rst index 7984938..a3fd0dd 100644 --- a/doc/en/ref_algorithm_SamplingTest.rst +++ b/doc/en/ref_algorithm_SamplingTest.rst @@ -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 diff --git a/doc/en/ref_sampling_requirements.rst b/doc/en/ref_sampling_requirements.rst index 3ec4a46..e9a383f 100644 --- a/doc/en/ref_sampling_requirements.rst +++ b/doc/en/ref_sampling_requirements.rst @@ -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: diff --git a/doc/en/snippets/SampleAsMinMaxSobolSequence.rst b/doc/en/snippets/SampleAsMinMaxSobolSequence.rst index 584f2f3..0be97cd 100644 --- a/doc/en/snippets/SampleAsMinMaxSobolSequence.rst +++ b/doc/en/snippets/SampleAsMinMaxSobolSequence.rst @@ -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). diff --git a/doc/fr/ref_algorithm_EnsembleOfSimulationGenerationTask.rst b/doc/fr/ref_algorithm_EnsembleOfSimulationGenerationTask.rst index 72a6688..8557f3a 100644 --- a/doc/fr/ref_algorithm_EnsembleOfSimulationGenerationTask.rst +++ b/doc/fr/ref_algorithm_EnsembleOfSimulationGenerationTask.rst @@ -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. diff --git a/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst b/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst index c939d7c..a441bbd 100644 --- a/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst +++ b/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst @@ -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: diff --git a/doc/fr/ref_algorithm_SamplingTest.rst b/doc/fr/ref_algorithm_SamplingTest.rst index 12912c8..ce16e34 100644 --- a/doc/fr/ref_algorithm_SamplingTest.rst +++ b/doc/fr/ref_algorithm_SamplingTest.rst @@ -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. diff --git a/doc/fr/ref_sampling_requirements.rst b/doc/fr/ref_sampling_requirements.rst index 8fad23b..7b90bf6 100644 --- a/doc/fr/ref_sampling_requirements.rst +++ b/doc/fr/ref_sampling_requirements.rst @@ -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 : diff --git a/doc/fr/snippets/SampleAsMinMaxSobolSequence.rst b/doc/fr/snippets/SampleAsMinMaxSobolSequence.rst index 6882b18..2bd61bd 100644 --- a/doc/fr/snippets/SampleAsMinMaxSobolSequence.rst +++ b/doc/fr/snippets/SampleAsMinMaxSobolSequence.rst @@ -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). -- 2.30.2