Skip to content

Commit f07fe17

Browse files
author
Mathias Born
committed
Added something to README, small cleanup of index in docs
1 parent b3360a8 commit f07fe17

File tree

4 files changed

+12
-4
lines changed

4 files changed

+12
-4
lines changed

Diff for: .gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ ignore/*
1919
test.ipynb
2020
*.csv
2121
*.lprof
22-
docs/source/generated/*
22+
docs/source/_generated/*
2323
docs/out/*
2424
examples/archive/*
2525

Diff for: README.md

+4
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@ To generate experimental designs, there are two main options:
6262
[a-priori variance ratios](https://pyoptex.readthedocs.io/en/latest/_docs/doe/customization.html#cust-bayesian-ratio)
6363
in designs with hard-to-change factors.
6464

65+
* High-performance **model selection** using
66+
[SAMS](https://pyoptex.readthedocs.io/en/latest/_docs/analysis/customization.html#a-cust-sams)
67+
(simulated annealing model selection)
68+
[(Wolters and Bingham, 2012)](https://www.tandfonline.com/doi/abs/10.1198/TECH.2011.08157).
6569

6670
## Getting started
6771

Diff for: docs/source/api.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ API
66
.. rubric:: Modules
77

88
.. autosummary::
9-
:toctree: generated
9+
:toctree: _generated
1010
:template: module.rst
1111
:recursive:
1212

Diff for: docs/source/index.rst

+6-2
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,18 @@ To generate experimental designs, there are two main options:
3838

3939
The overview of the PyOptEx package.
4040

41-
See the :ref:`quickstart` for more information on how to generate different kinds of
41+
See the design of experiments :ref:`quickstart` for more information on how to generate different kinds of
4242
designs. See :ref:`customization` for a more detailed explanation on how to tune and
4343
customize each algorithm. Reseachers can find more information here
4444
on how to design custom criteria. The example scenarios are noted in :ref:`d_example_scenarios`.
4545
Finally, see :ref:`performance` for some tips on how
4646
to make the algorithm run faster.
4747

48+
To analyze the data after the experiment, have a look at the analysis :ref:`a_quickstart`.
49+
4850
.. note::
4951

50-
This project is under active development. Analysis and model selection will follow.
52+
This project is under active development.
5153

5254
Main features
5355
-------------
@@ -67,6 +69,8 @@ Main features
6769
:ref:`linear model <cust_model>`, :ref:`encoding of the categorical factors <cust_cat_encoding>`, and much more.
6870
* Directly optimize for **Bayesian** :ref:`a-priori variance ratios <cust_bayesian_ratio>` in designs with
6971
hard-to-change factors.
72+
* High-performance **model selection** using :ref:`SAMS <a_cust_sams>` (simulated annealing model selection)
73+
`(Wolters and Bingham, 2012) <https://www.tandfonline.com/doi/abs/10.1198/TECH.2011.08157>`_.
7074

7175
Documentation
7276
-------------

0 commit comments

Comments
 (0)