Skip to content

Commit

Permalink
Update doc with pydoe samplings
Browse files Browse the repository at this point in the history
  • Loading branch information
relf committed Nov 29, 2023
1 parent b08732a commit 4d3abef
Show file tree
Hide file tree
Showing 15 changed files with 300 additions and 25 deletions.
7 changes: 4 additions & 3 deletions doc/_src_docs/sampling_methods.rst

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions doc/_src_docs/sampling_methods/lhs.rstx
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ The LHS method uses the pyDOE package (Design of Experiments for Python) [1]_. F

The four first criteria are the same than in pyDOE (for more details, see [1]_). The last criterion, ESE, is implemented by the authors of SMT (more details about such method could be found in [2]_).

.. [1] https://pythonhosted.org/pyDOE/index.html
.. [1] https://pydoe3.readthedocs.io/en/stable

.. [2] Jin, R. and Chen, W. and Sudjianto, A. (2005), "An efficient algorithm for constructing optimal design of computer experiments." Journal of Statistical Planning and Inference, 134:268-287.

Usage
-----

.. embed-test-print-plot :: smt.sampling_methods.tests.test_sampling_method_examples , Test , test_lhs , 80
.. embed-test-print-plot :: smt.sampling_methods.tests.test_sampling_method_examples , Test , run_lhs , 80

Options
-------
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
267 changes: 267 additions & 0 deletions doc/_src_docs/sampling_methods/pydoe.rst

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 3 additions & 4 deletions doc/_src_docs/sampling_methods/pydoe.rstx
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
pyDOE sampling methods (Box Behnken, Plackett-Burman, Factorial and Generalized Subset Designs)
===============================================================================================
PyDOE sampling methods
======================

pyDOE is a package for design of experiments [1]_.
The optimized LHS in SMT is build on top of pyDOE3 LHS implementation.

Main design functions provided by pyDOE are made available behind an adapter base class `PyDoeSamplingMethod`
Main design functions provided by pyDOE are made available through an adapter base class `PyDoeSamplingMethod`
which make them compliant with `SamplingMethod` base class interface.

While historically sampling method interface requires to specify a number of points, pyDOE designs
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/_src_docs/sampling_methods_Test_test_random.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion doc/index.rst

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 4d3abef

Please sign in to comment.