Skip to content

Commit

Permalink
Add cut and examples to Sphinx docs (#231)
Browse files Browse the repository at this point in the history
* Update index.rst

* Update observational.rst

* Update README.rst
  • Loading branch information
eb8680 authored Aug 7, 2023
1 parent c979555 commit b8181ec
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,10 @@ approximations that power much of the modern probabilistic machine learning land
- Counterfactuals with normalizing flows
- `Example: Structured Latent Confounders <https://basisresearch.github.io/chirho/slc.html>`_
- Causal effect estimation when latent confounders are shared across groups
- `Example: Synthetic difference-in-differences <https://basisresearch.github.io/chirho/sdid.html>`_
- Counterfactual estimation from longitudinal data
- `Example: Robust estimation with the DR learner <https://basisresearch.github.io/chirho/dr_learner.html>`_
- Heterogeneous causal effect estimation with a misspecified model
- `Design notes <https://basisresearch.github.io/chirho/design_notes>`_
- Technical implementation details of ChiRho using effect handlers

Expand Down Expand Up @@ -184,4 +188,4 @@ Pearl, Judea. *Causality: Models, Reasoning and Inference*. 2nd ed. USA: Cambrid


.. |Build Status| image:: https://github.com/BasisResearch/chirho/actions/workflows/test.yml/badge.svg
:target: https://github.com/BasisResearch/chirho/actions/workflows/test.yml
:target: https://github.com/BasisResearch/chirho/actions/workflows/test.yml
2 changes: 2 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ Table of Contents
deepscm
slc
mediation
sdid
dr_learner

.. toctree::
:maxdepth: 2
Expand Down
6 changes: 5 additions & 1 deletion docs/source/observational.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,13 @@ Handlers
:members:
:undoc-members:

.. automodule:: chirho.observational.handlers.cut
:members:
:undoc-members:

Internals
---------

.. automodule:: chirho.observational.internals
:members:
:undoc-members:
:undoc-members:

0 comments on commit b8181ec

Please sign in to comment.