Merge pull request #64 from pymc-labs/examples

Split the notebooks into separate examples + update toctree

Author: drbenvincent

README.md

@@ -10,7 +10,7 @@ _**STATUS:** Feel free to explore and experiment with the repository, and we ver
 
 Rather than focussing on one particular quasi-experimental setting, this package aims to have broad applicability.
 
-Another distinctive feature of this package is the ability to use different models. Currently, users can fit with `scikit-learn` models (see the [`scikit-learn` demo notebook](notebooks/skl_demos.ipynb)) or Bayesian models with `PyMC` (see the [`pymc` demo notebook](notebooks/pymc_demos.ipynb)).
+Another distinctive feature of this package is the ability to use different models. Currently, users can fit with `scikit-learn` models or Bayesian models with `PyMC`.
 
 |                           | [CausalImpact](https://google.github.io/CausalImpact/) from Google | [GeoLift](https://github.com/facebookincubator/GeoLift/) from Meta | CausalPy from [PyMC Labs](https://www.pymc-labs.io) |
 |---------------------------|--------------------------------|---------|----------------------------------------|

docs/examples.rst

@@ -0,0 +1,40 @@
+Synthetic Control
+=================
+
+.. toctree::
+   :titlesonly:
+
+   notebooks/sc_pymc.ipynb
+   notebooks/sc_skl.ipynb
+
+
+Interrupted Time Series
+=======================
+
+.. toctree::
+   :titlesonly:
+
+   notebooks/its_pymc.ipynb
+   notebooks/its_skl.ipynb
+
+
+Difference in Differences
+=========================
+
+.. toctree::
+   :titlesonly:
+
+   notebooks/did_pymc.ipynb
+   notebooks/did_skl.ipynb
+
+
+Regression Discontinuity
+========================
+
+.. toctree::
+   :titlesonly:
+
+   notebooks/rd_pymc.ipynb
+   notebooks/rd_pymc_drinking.ipynb
+   notebooks/rd_skl.ipynb
+   notebooks/rd_skl_drinking.ipynb

docs/index.rst

@@ -19,19 +19,14 @@ This repository is supported by `PyMC Labs <https://www.pymc-labs.io>`_.
    :scale: 50 %
 
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
 Documentation outline
 =====================
 
 .. toctree::
    :caption: Examples
    :titlesonly:
 
-   notebooks/skl_demos.ipynb
-   notebooks/pymc_demos.ipynb
+   examples
 
 .. toctree::
    :caption: API Reference