.. Copyright 2021 IRT Saint-Exupéry, https://www.irt-saintexupery.com This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. .. _gen_doe_algos: DOE algorithms ============== .. warning:: Some capabilities may require the :ref:`installation ` of |g| with :ref:`all its features ` and some others may depend on :ref:`plugins `. .. note:: All the features of the wrapped libraries may not be exposed through |g|. .. seealso:: You can find more information about this family of algorithms in :ref:`the user guide `. .. raw:: html .. _CustomDOE_options: CustomDOE --------- Module: :class:`gemseo.algos.doe.lib_custom` This samples are provided either as a file in text or csv format or as a sequence of sequences of numbers. .. raw:: html
Required parameters
  • **doe_file** : *str | Path | None* The path to the file containing the input samples. If ``None``, use ``samples``. .. raw:: html
  • **samples** : *RealArray | dict[str, RealArray] | list[dict[str, RealArray]] | None* The input samples. They must be at least a 2D-array, a dictionary of 2D-arrays or a list of dictionaries of 1D-arrays. If ``None``, use ``doe_file``. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **comments** : *str | Sequence[str] | None, optional* The characters or list of characters used to indicate the start of a comment. ``None`` implies no comments. By default it is set to #. .. raw:: html
  • **delimiter** : *str | None, optional* The character used to separate values. If ``None``, use whitespace. By default it is set to ,. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **skiprows** : *int, optional* The number of first lines to skip. By default it is set to 0. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _DiagonalDOE_options: DiagonalDOE ----------- Module: :class:`gemseo.algos.doe.lib_scalable` Diagonal design of experiments .. raw:: html
Required parameters
  • **n_samples** : *int* The number of samples. The number of samples must be greater than or equal to 2. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the Jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds. If 0, no maximum runtime is set. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **reverse** : *Container[str] | None, optional* The dimensions or variables to sample from their upper bounds to their lower bounds. If ``None``, every dimension will be sampled from its lower bound to its upper bound. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _Halton_options: Halton ------ Module: :class:`gemseo.algos.doe.lib_scipy` Halton sequence .. raw:: html
Required parameters
  • **n_samples** : *int* The number of samples. .. raw:: html
  • **optimization** : *Optimizer* The name of an optimization scheme to improve the quality of the DOE. If ``None``, use the DOE as is. New in SciPy 1.10.0. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **scramble** : *bool, optional* Whether to use scrambling (Owen type). Only available with SciPy >= 1.10.0. By default it is set to True. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _LHS_options: LHS --- Module: :class:`gemseo.algos.doe.lib_scipy` Latin hypercube sampling (LHS) .. raw:: html
Required parameters
  • **n_samples** : *int* The number of samples. .. raw:: html
  • **optimization** : *Optimizer* The name of an optimization scheme to improve the quality of the DOE. If ``None``, use the DOE as is. New in SciPy 1.10.0. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **centered** : *bool, optional* Whether to center the samples within the cells of a multi-dimensional grid. If SciPy >= 1.10.0, use ``scramble`` instead. By default it is set to False. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **scramble** : *bool, optional* Whether to use scrambling (Owen type). Only available with SciPy >= 1.10.0. By default it is set to True. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **strength** : *Literal[1, 2], optional* The strength of the LHS. By default it is set to 1. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _MC_options: MC -- Module: :class:`gemseo.algos.doe.lib_scipy` Monte Carlo sampling .. raw:: html
Required parameters
  • **n_samples** : *int* The number of samples. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _OT_AXIAL_options: OT_AXIAL -------- Module: :class:`gemseo.algos.doe.lib_openturns` Axial design More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Axial.html. .. raw:: html
Required parameters
  • **levels** : *float | Sequence[float] | None* 1) In the case of axial, composite and factorial DOEs, the positions of the levels relative to the center; the levels will be equispaced and symmetrical relative to the center; e.g. ``[0.2, 0.8]`` in dimension 1 will generate the samples ``[0.15, 0.6, 0.75, 0.8, 0.95, 1]`` for an axial DOE; the values must be in :math:`]0,1]`. 2) In the case of a full-factorial DOE, the number of levels per input direction; if scalar, this value is applied to each input direction. .. raw:: html
  • **n_samples** : *int | None* The maximum number of samples required by the user; for axial, composite and factorial DOEs, a minimum number of samples is required and depends on the dimension of the space to sample; if ``None`` in the case of for axial, composite, factorial and full-factorial DOEs the effective number of samples is computed from this dimension and the number of levels. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **centers** : *Sequence[float] | float, optional* The center of the unit hypercube that the axial, composite or factorial DOE algorithm will sample; if scalar, this value is applied to each direction of the hypercube; the values must be in :math:`]0,1[`. By default it is set to 0.5. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _OT_COMPOSITE_options: OT_COMPOSITE ------------ Module: :class:`gemseo.algos.doe.lib_openturns` Composite design More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Composite.html. .. raw:: html
Required parameters
  • **levels** : *float | Sequence[float] | None* 1) In the case of axial, composite and factorial DOEs, the positions of the levels relative to the center; the levels will be equispaced and symmetrical relative to the center; e.g. ``[0.2, 0.8]`` in dimension 1 will generate the samples ``[0.15, 0.6, 0.75, 0.8, 0.95, 1]`` for an axial DOE; the values must be in :math:`]0,1]`. 2) In the case of a full-factorial DOE, the number of levels per input direction; if scalar, this value is applied to each input direction. .. raw:: html
  • **n_samples** : *int | None* The maximum number of samples required by the user; for axial, composite and factorial DOEs, a minimum number of samples is required and depends on the dimension of the space to sample; if ``None`` in the case of for axial, composite, factorial and full-factorial DOEs the effective number of samples is computed from this dimension and the number of levels. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **centers** : *Sequence[float] | float, optional* The center of the unit hypercube that the axial, composite or factorial DOE algorithm will sample; if scalar, this value is applied to each direction of the hypercube; the values must be in :math:`]0,1[`. By default it is set to 0.5. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _OT_FACTORIAL_options: OT_FACTORIAL ------------ Module: :class:`gemseo.algos.doe.lib_openturns` Factorial design More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Factorial.html. .. raw:: html
Required parameters
  • **levels** : *float | Sequence[float] | None* 1) In the case of axial, composite and factorial DOEs, the positions of the levels relative to the center; the levels will be equispaced and symmetrical relative to the center; e.g. ``[0.2, 0.8]`` in dimension 1 will generate the samples ``[0.15, 0.6, 0.75, 0.8, 0.95, 1]`` for an axial DOE; the values must be in :math:`]0,1]`. 2) In the case of a full-factorial DOE, the number of levels per input direction; if scalar, this value is applied to each input direction. .. raw:: html
  • **n_samples** : *int | None* The maximum number of samples required by the user; for axial, composite and factorial DOEs, a minimum number of samples is required and depends on the dimension of the space to sample; if ``None`` in the case of for axial, composite, factorial and full-factorial DOEs the effective number of samples is computed from this dimension and the number of levels. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **centers** : *Sequence[float] | float, optional* The center of the unit hypercube that the axial, composite or factorial DOE algorithm will sample; if scalar, this value is applied to each direction of the hypercube; the values must be in :math:`]0,1[`. By default it is set to 0.5. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _OT_FAURE_options: OT_FAURE -------- Module: :class:`gemseo.algos.doe.lib_openturns` Faure sequence More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.FaureSequence.html. .. raw:: html
Required parameters
  • **n_samples** : *int | None* The maximum number of samples required by the user; for axial, composite and factorial DOEs, a minimum number of samples is required and depends on the dimension of the space to sample; if ``None`` in the case of for axial, composite, factorial and full-factorial DOEs the effective number of samples is computed from this dimension and the number of levels. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _OT_FULLFACT_options: OT_FULLFACT ----------- Module: :class:`gemseo.algos.doe.lib_openturns` Full factorial design More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Box.html. .. raw:: html
Required parameters
  • **levels** : *float | Sequence[float] | None* 1) In the case of axial, composite and factorial DOEs, the positions of the levels relative to the center; the levels will be equispaced and symmetrical relative to the center; e.g. ``[0.2, 0.8]`` in dimension 1 will generate the samples ``[0.15, 0.6, 0.75, 0.8, 0.95, 1]`` for an axial DOE; the values must be in :math:`]0,1]`. 2) In the case of a full-factorial DOE, the number of levels per input direction; if scalar, this value is applied to each input direction. .. raw:: html
  • **n_samples** : *int | None* The maximum number of samples required by the user; for axial, composite and factorial DOEs, a minimum number of samples is required and depends on the dimension of the space to sample; if ``None`` in the case of for axial, composite, factorial and full-factorial DOEs the effective number of samples is computed from this dimension and the number of levels. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _OT_HALTON_options: OT_HALTON --------- Module: :class:`gemseo.algos.doe.lib_openturns` Halton sequence More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.HaltonSequence.html. .. raw:: html
Required parameters
  • **n_samples** : *int | None* The maximum number of samples required by the user; for axial, composite and factorial DOEs, a minimum number of samples is required and depends on the dimension of the space to sample; if ``None`` in the case of for axial, composite, factorial and full-factorial DOEs the effective number of samples is computed from this dimension and the number of levels. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _OT_HASELGROVE_options: OT_HASELGROVE ------------- Module: :class:`gemseo.algos.doe.lib_openturns` Haselgrove sequence More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.HaselgroveSequence.html. .. raw:: html
Required parameters
  • **n_samples** : *int | None* The maximum number of samples required by the user; for axial, composite and factorial DOEs, a minimum number of samples is required and depends on the dimension of the space to sample; if ``None`` in the case of for axial, composite, factorial and full-factorial DOEs the effective number of samples is computed from this dimension and the number of levels. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _OT_LHS_options: OT_LHS ------ Module: :class:`gemseo.algos.doe.lib_openturns` Latin Hypercube Sampling More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.LHS.html. .. raw:: html
Required parameters
  • **n_samples** : *int | None* The maximum number of samples required by the user; for axial, composite and factorial DOEs, a minimum number of samples is required and depends on the dimension of the space to sample; if ``None`` in the case of for axial, composite, factorial and full-factorial DOEs the effective number of samples is computed from this dimension and the number of levels. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _OT_LHSC_options: OT_LHSC ------- Module: :class:`gemseo.algos.doe.lib_openturns` Centered Latin Hypercube Sampling More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.LHS.html. .. raw:: html
Required parameters
  • **n_samples** : *int | None* The maximum number of samples required by the user; for axial, composite and factorial DOEs, a minimum number of samples is required and depends on the dimension of the space to sample; if ``None`` in the case of for axial, composite, factorial and full-factorial DOEs the effective number of samples is computed from this dimension and the number of levels. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _OT_MONTE_CARLO_options: OT_MONTE_CARLO -------------- Module: :class:`gemseo.algos.doe.lib_openturns` Monte Carlo sequence More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Uniform.html. .. raw:: html
Required parameters
  • **n_samples** : *int | None* The maximum number of samples required by the user; for axial, composite and factorial DOEs, a minimum number of samples is required and depends on the dimension of the space to sample; if ``None`` in the case of for axial, composite, factorial and full-factorial DOEs the effective number of samples is computed from this dimension and the number of levels. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _OT_OPT_LHS_options: OT_OPT_LHS ---------- Module: :class:`gemseo.algos.doe.lib_openturns` Optimal Latin Hypercube Sampling More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.SimulatedAnnealingLHS.html. .. raw:: html
Required parameters
  • **n_samples** : *int | None* The maximum number of samples required by the user; for axial, composite and factorial DOEs, a minimum number of samples is required and depends on the dimension of the space to sample; if ``None`` in the case of for axial, composite, factorial and full-factorial DOEs the effective number of samples is computed from this dimension and the number of levels. .. raw:: html
Optional parameters
  • **annealing** : *bool, optional* If ``True``, use simulated annealing to optimize LHS. Otherwise, use crude Monte Carlo. By default it is set to True. .. raw:: html
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **criterion** : *OTOptimalLHS.SpaceFillingCriterion, optional* The space-filling criterion, either "C2", "PhiP" or "MinDist". By default it is set to C2. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **levels** : *float | Sequence[float] | None, optional* 1) In the case of axial, composite and factorial DOEs, the positions of the levels relative to the center; the levels will be equispaced and symmetrical relative to the center; e.g. ``[0.2, 0.8]`` in dimension 1 will generate the samples ``[0.15, 0.6, 0.75, 0.8, 0.95, 1]`` for an axial DOE; the values must be in :math:`]0,1]`. 2) In the case of a full-factorial DOE, the number of levels per input direction; if scalar, this value is applied to each input direction. By default it is set to None. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **n_replicates** : *int, optional* The number of Monte Carlo replicates to optimize LHS. By default it is set to 1000. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **temperature** : *OTOptimalLHS.TemperatureProfile, optional* The temperature profile for simulated annealing, either "Geometric" or "Linear". By default it is set to Geometric. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _OT_RANDOM_options: OT_RANDOM --------- Module: :class:`gemseo.algos.doe.lib_openturns` Random sampling More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.Uniform.html. .. raw:: html
Required parameters
  • **n_samples** : *int | None* The maximum number of samples required by the user; for axial, composite and factorial DOEs, a minimum number of samples is required and depends on the dimension of the space to sample; if ``None`` in the case of for axial, composite, factorial and full-factorial DOEs the effective number of samples is computed from this dimension and the number of levels. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _OT_REVERSE_HALTON_options: OT_REVERSE_HALTON ----------------- Module: :class:`gemseo.algos.doe.lib_openturns` Reverse Halton More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.ReverseHaltonSequence.html. .. raw:: html
Required parameters
  • **n_samples** : *int | None* The maximum number of samples required by the user; for axial, composite and factorial DOEs, a minimum number of samples is required and depends on the dimension of the space to sample; if ``None`` in the case of for axial, composite, factorial and full-factorial DOEs the effective number of samples is computed from this dimension and the number of levels. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _OT_SOBOL_options: OT_SOBOL -------- Module: :class:`gemseo.algos.doe.lib_openturns` Sobol sequence More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.SobolSequence.html. .. raw:: html
Required parameters
  • **n_samples** : *int | None* The maximum number of samples required by the user; for axial, composite and factorial DOEs, a minimum number of samples is required and depends on the dimension of the space to sample; if ``None`` in the case of for axial, composite, factorial and full-factorial DOEs the effective number of samples is computed from this dimension and the number of levels. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _OT_SOBOL_INDICES_options: OT_SOBOL_INDICES ---------------- Module: :class:`gemseo.algos.doe.lib_openturns` DOE for Sobol 'indices More details about the algorithm and its options on http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.SobolIndicesAlgorithm.html. .. raw:: html
Required parameters
  • **n_samples** : *int | None* The maximum number of samples required by the user; for axial, composite and factorial DOEs, a minimum number of samples is required and depends on the dimension of the space to sample; if ``None`` in the case of for axial, composite, factorial and full-factorial DOEs the effective number of samples is computed from this dimension and the number of levels. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **eval_second_order** : *bool, optional* Whether to build a DOE to evaluate also the second-order indices; otherwise, the DOE is designed for first- and total-order indices only. By default it is set to True. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _PoissonDisk_options: PoissonDisk ----------- Module: :class:`gemseo.algos.doe.lib_scipy` Poisson disk sampling .. raw:: html
Required parameters
  • **n_samples** : *int* The number of samples. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **hypersphere** : *Hypersphere, optional* The sampling strategy to generate potential candidates to be added in the final sample. By default it is set to volume. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **ncandidates** : *int, optional* The number of candidates to sample per iteration. By default it is set to 30. .. raw:: html
  • **radius** : *float, optional* The minimal distance to keep between points when sampling new candidates. By default it is set to 0.05. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _Sobol_options: Sobol ----- Module: :class:`gemseo.algos.doe.lib_scipy` Engine for generating (scrambled) Sobol' sequences .. raw:: html
Required parameters
  • **n_samples** : *int* The number of samples. .. raw:: html
  • **optimization** : *Optimizer* The name of an optimization scheme to improve the quality of the DOE. If ``None``, use the DOE as is. New in SciPy 1.10.0. .. raw:: html
Optional parameters
  • **bits** : *int | None, optional* The number of bits of the generator. New in SciPy 1.9.0. By default it is set to None. .. raw:: html
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **scramble** : *bool, optional* Whether to use scrambling (Owen type). Only available with SciPy >= 1.10.0. By default it is set to True. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _bbdesign_options: bbdesign -------- Module: :class:`gemseo.algos.doe.lib_pydoe` Box-Behnken design implemented in pyDOE More details about the algorithm and its options on https://pythonhosted.org/pyDOE/rsm.html#box-behnken. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **center_bb** : *int | None, optional* The number of center points for the Box-Behnken design. If ``None``, use a pre-determined number of points. By default it is set to None. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _ccdesign_options: ccdesign -------- Module: :class:`gemseo.algos.doe.lib_pydoe` Central Composite implemented in pyDOE More details about the algorithm and its options on https://pythonhosted.org/pyDOE/rsm.html#central-composite. .. raw:: html
Optional parameters
  • **alpha** : *str, optional* A parameter to describe how the variance is distributed. Either "orthogonal" or "rotatable". By default it is set to orthogonal. .. raw:: html
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **center_cc** : *tuple[int, int] | None, optional* The 2-tuple of center points for the central composite design. If ``None``, use (4, 4). By default it is set to None. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **face** : *str, optional* The relation between the start points and the corner (factorial) points. Either "circumscribed", "inscribed" or "faced". By default it is set to faced. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _ff2n_options: ff2n ---- Module: :class:`gemseo.algos.doe.lib_pydoe` 2-Level Full-Factorial implemented in pyDOE More details about the algorithm and its options on https://pythonhosted.org/pyDOE/factorial.html#level-full-factorial. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _fullfact_options: fullfact -------- Module: :class:`gemseo.algos.doe.lib_pydoe` Full-Factorial implemented in pyDOE More details about the algorithm and its options on https://pythonhosted.org/pyDOE/factorial.html#general-full-factorial. .. raw:: html
Required parameters
  • **levels** : *Sequence[int] | None* The levels. If there is a parameter ``n_samples``, the latter can be specified and the former set to its default value ``None``. .. raw:: html
  • **n_samples** : *int | None* The number of samples. If there is a parameter ``levels``, the latter can be specified and the former set to its default value ``None``. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _lhs_options: lhs --- Module: :class:`gemseo.algos.doe.lib_pydoe` Latin Hypercube Sampling implemented in pyDOE More details about the algorithm and its options on https://pythonhosted.org/pyDOE/randomized.html#latin-hypercube. .. raw:: html
Required parameters
  • **n_samples** : *int | None* The number of samples. If there is a parameter ``levels``, the latter can be specified and the former set to its default value ``None``. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **criterion** : *str | None, optional* The criterion to use when sampling the points. If ``None``, randomize the points within the intervals. By default it is set to None. .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **iterations** : *int, optional* The number of iterations in the `correlation` and `maximin` algorithms. By default it is set to 5. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **seed** : *int | None, optional* The seed used for reproducibility reasons. If ``None``, use :attr:`.seed`. By default it is set to None. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html
.. _pbdesign_options: pbdesign -------- Module: :class:`gemseo.algos.doe.lib_pydoe` Plackett-Burman design implemented in pyDOE More details about the algorithm and its options on https://pythonhosted.org/pyDOE/factorial.html#plackett-burman. .. raw:: html
Optional parameters
  • **callbacks** : *Iterable[CallbackType], optional* The functions to be evaluated after each call to :meth:`.OptimizationProblem.evaluate_functions`; to be called as ``callback(index, (output, jacobian))``. By default it is set to (). .. raw:: html
  • **eval_jac** : *bool, optional* Whether to evaluate the jacobian. By default it is set to False. .. raw:: html
  • **max_time** : *float, optional* The maximum runtime in seconds, disabled if 0. By default it is set to 0. .. raw:: html
  • **n_processes** : *int, optional* The maximum simultaneous number of processes used to parallelize the execution. By default it is set to 1. .. raw:: html
  • **wait_time_between_samples** : *float, optional* The waiting time between two samples. By default it is set to 0.0. .. raw:: html