Skip to content

Commit 518146e

Browse files
committed
DOC: update example readme
1 parent ab28d3d commit 518146e

File tree

2 files changed

+66
-74
lines changed

2 files changed

+66
-74
lines changed

examples/README.rst

Lines changed: 0 additions & 58 deletions
This file was deleted.

examples/index.rst

Lines changed: 66 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,71 @@
11
PySensors Examples
22
==================
33

4-
Here we provide examples of how to use `PySensors` objects to solve sensor placement problems.
4+
This directory provides examples of how to use `PySensors` objects to solve sensor placement problems.
5+
`PySensors` was designed to be completely compatible with `scikit-learn`.
6+
7+
`PySensors Overview <./pysensors_overview.ipynb>`__
8+
---------------------------------------------------
9+
This notebook gives an overview of most of the different tools available in `PySensors`. It's a good place to start to get a quick idea of what the package is capable of.
10+
11+
.. toctree::
12+
:hidden:
13+
:maxdepth: 1
14+
15+
pysensors_overview
16+
17+
`Classification <./classification.ipynb>`__
18+
-------------------------------------------
19+
This notebook showcases the use of `SSPOC` class (Sparse Sensor Placement Optimization for Classification) to choose sparse sets of sensors for *classification* problems.
20+
21+
.. toctree::
22+
:hidden:
23+
:maxdepth: 1
24+
25+
classification
26+
27+
Reconstruction
28+
--------------
29+
These notebooks show how the `SSPOR` class (Sparse Sensor Placement Optimization for Reconstruction) can be used with different optimizers.
30+
The default optimizer for `SSPOR` is `QR`, which uses QR pivoting to select sensors in unconstrained problems.
31+
`GQR` (General QR) optimizer provides a more intrusive approach into the `QR` pivoting procedure to take into account spatial constraints. The `General QR Optimizer for Spatial Constraints <./spatial_constrained_qr.ipynb>`__ and `Functional Constraints for Olivetti Faces <./Olivetti_constrained_sensing.ipynb>`__ notebooks provide a detailed account of unconstrained and constrained sensor placement.
32+
`CCQR` (Cost Constrained QR) optimizer can be used to place sparse sensors when there are variable costs associated with different locations. The `Cost Constrained QR <./cost_constrained_qr.ipynb>`__ notebook showcases the `CCQR` optimizer.
33+
`TPGR` (Two Point GReedy) optimizer uses a thermodynamic approach to sensor placement that maps the complete landscape of sensor interactions induced by the training data and places sensors such that the marginal energy of each next placed sensor is minimized. The `TPGR <./two_point_greedy.ipynb>`__ notebook goes into detail about the optimizer and the one-point and two-point enery landscape computation. The `TPGR` optimizer requires prior and noise.
34+
35+
There are two methods used for reconstruction: `Unregularized Reconstruction`, which uses the Moore-Penrose Pseudoinverse method, and `Regularized Reconstruction`, that uses a maximal likelihood reconstructor that requires a prior and noise.
36+
The `Reconstruction Comparison <./reconstruction_comparison.ipynb>`__ notebook compares these two methods using the `TPGR` optimizer. It also shows a comparison between `TPGR` and `QR` optimizers using both of the reconstruction methods.
537

638
.. toctree::
7-
:maxdepth: 1
8-
:caption: Example Notebooks
9-
10-
pysensors_overview
11-
basis_comparison
12-
classification
13-
cost_constrained_qr
14-
cross_validation
15-
sea_surface_temperature
16-
reconstruction_comparison
17-
two_point_greedy
18-
polynomial_curve_fitting
19-
spatial_constrained_qr
20-
Olivetti_constrained_sensing
21-
OPTI-TWIST_constrained_sensing
39+
:hidden:
40+
:maxdepth: 1
41+
42+
spatial_constrained_qr
43+
Olivetti_constrained_sensing
44+
cost_constrained_qr
45+
two_point_greedy
46+
reconstruction_comparison
47+
48+
Basis
49+
-----
50+
The `Basis Comparison <./basis_comparison.ipynb>`__ notebook compares the different basis options implemented in `PySensors` on a simple problem.
51+
`Cross Validation<./cross_validation.ipynb>`__ is also performed with `scikit-learn` objects to optimize the number of sensors and/or basis modes.
52+
53+
.. toctree::
54+
:hidden:
55+
:maxdepth: 1
56+
57+
basis_comparison
58+
cross_validation
59+
60+
Applications
61+
------------
62+
These notebooks showcase the sensor placement optimization methods on datasets ranging from `Sea Surface Temperature <./sea_surface_temperature.ipynb>`__ to predicting the temperature within a `Fuel Rod <./OPTI-TWIST_constrained_sensing.ipynb>`__ with spatially constrained sensors.
63+
The `Polynomial Curve Fitting <./polynomial_curve_fitting>`__ notebook demonstrates how to use PySensors to select sensor locations for polynomial interpolation using the monomial basis $1, x, x^2, x^3, \dots, x^k$.
64+
65+
.. toctree::
66+
:hidden:
67+
:maxdepth: 1
68+
69+
sea_surface_temperature
70+
polynomial_curve_fitting
71+
OPTI-TWIST_constrained_sensing

0 commit comments

Comments
 (0)