diff --git a/docs/source/code_repo.rst b/docs/source/code_repo.rst index 42a5023348..f8833fe91f 100644 --- a/docs/source/code_repo.rst +++ b/docs/source/code_repo.rst @@ -6,6 +6,53 @@ DoWhy is hosted on GitHub. You can browse the code in a html-friendly format `here `_. +v0.9: New functional API (preview), faster refutations, and better independence tests for GCMs +---------------------------------------------------------------------------------------------- +December 5 2022 + +* Preview for the new functional API (see `notebook `_). The new API (in experimental stage) allows for a modular use of the different functionalities and includes separate fit and estimate methods for causal estimators. Please leave your feedback here. The old DoWhy API based on CausalModel should work as before. (@andresmor-ms) + +* Faster, better sensitivity analyses. + * Many refutations now support joblib for parallel processing and show a progress bar (@astoeffelbauer, @yemaedahrav). + * Non-linear sensitivity analysis [`Chernozhukov, Cinelli, Newey, Sharma & Syrgkanis (2021) `_, `example notebook `_] (@anusha0409) + * E-value sensitivity analysis [`Ding & Vanderweele (2016) `, `example notebook `_] (@jlgleason) + +* New API for unit change attribution (@kailashbuki) + +* New quality option `BEST` for auto-assignment of causal mechanisms, which uses the optional auto-ML library AutoGluon (@bloebp) + +* Better conditional independence tests through the causal-learn package (@bloebp) + +* Algorithms for computing efficient backdoor sets [`example notebook `_] (@esmucler) + +* Support for estimating controlled direct effect (@amit-sharma) + +* Support for multi-valued treatments for econml estimators (@EgorKraevTransferwise) + +* New PyData theme for documentation with new homepage, Getting started guide, revised User Guide and examples page (@petergtz) + +* A `contributing guide `_ and simplified instructions for new contributors (@MichaelMarien) + +* Streamlined dev environment using Poetry for managing dependencies and project builds (@darthtrevino) + +* Bug fixes + +v0.8: GCM support and partial R2-based sensitivity analysis +------------------------------------------------------------- +July 18 2022 + +A big thanks to @petergtz, @kailashbuki, and @bloebp for the GCM package and @anusha0409 for an implementation of partial R2 sensitivity analysis for linear models. + +* **Graphical Causal Models**: SCMs, root-cause analysis, attribution, what-if analysis, and more. + +* **Sensitivity Analysis**: Faster, more general partial-R2 based sensitivity analysis for linear models, based on `Cinelli & Hazlett (2020) `_. + +* **New docs structure**: Updated docs structure including user and contributors' guide. Check out the `docs `_. + +* Bug fixes + +**Contributors**: @amit-sharma, @anusha0409, @bloebp, @EgorKraevTransferwise, @elikling, @kailashbuki, @itsoum, @MichaelMarien, @petergtz, @ryanrussell + v0.7.1: Added Graph refuter. Support for dagitty graphs and external estimators -------------------------------------------------------------------------------------- diff --git a/docs/source/dowhy.causal_identifier.rst b/docs/source/dowhy.causal_identifier.rst new file mode 100644 index 0000000000..701b8825e4 --- /dev/null +++ b/docs/source/dowhy.causal_identifier.rst @@ -0,0 +1,61 @@ +dowhy.causal\_identifier package +================================ + +Submodules +---------- + +dowhy.causal\_identifier.auto\_identifier module +------------------------------------------------ + +.. automodule:: dowhy.causal_identifier.auto_identifier + :members: + :undoc-members: + :show-inheritance: + +dowhy.causal\_identifier.backdoor module +---------------------------------------- + +.. automodule:: dowhy.causal_identifier.backdoor + :members: + :undoc-members: + :show-inheritance: + +dowhy.causal\_identifier.efficient\_backdoor module +--------------------------------------------------- + +.. automodule:: dowhy.causal_identifier.efficient_backdoor + :members: + :undoc-members: + :show-inheritance: + +dowhy.causal\_identifier.id\_identifier module +---------------------------------------------- + +.. automodule:: dowhy.causal_identifier.id_identifier + :members: + :undoc-members: + :show-inheritance: + +dowhy.causal\_identifier.identified\_estimand module +---------------------------------------------------- + +.. automodule:: dowhy.causal_identifier.identified_estimand + :members: + :undoc-members: + :show-inheritance: + +dowhy.causal\_identifier.identify\_effect module +------------------------------------------------ + +.. automodule:: dowhy.causal_identifier.identify_effect + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: dowhy.causal_identifier + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/dowhy.causal_refuters.rst b/docs/source/dowhy.causal_refuters.rst index 72689f106d..e87d7df772 100644 --- a/docs/source/dowhy.causal_refuters.rst +++ b/docs/source/dowhy.causal_refuters.rst @@ -36,6 +36,14 @@ dowhy.causal\_refuters.dummy\_outcome\_refuter module :undoc-members: :show-inheritance: +dowhy.causal\_refuters.evalue\_sensitivity\_analyzer module +----------------------------------------------------------- + +.. automodule:: dowhy.causal_refuters.evalue_sensitivity_analyzer + :members: + :undoc-members: + :show-inheritance: + dowhy.causal\_refuters.graph\_refuter module -------------------------------------------- @@ -52,6 +60,22 @@ dowhy.causal\_refuters.linear\_sensitivity\_analyzer module :undoc-members: :show-inheritance: +dowhy.causal\_refuters.non\_parametric\_sensitivity\_analyzer module +-------------------------------------------------------------------- + +.. automodule:: dowhy.causal_refuters.non_parametric_sensitivity_analyzer + :members: + :undoc-members: + :show-inheritance: + +dowhy.causal\_refuters.partial\_linear\_sensitivity\_analyzer module +-------------------------------------------------------------------- + +.. automodule:: dowhy.causal_refuters.partial_linear_sensitivity_analyzer + :members: + :undoc-members: + :show-inheritance: + dowhy.causal\_refuters.placebo\_treatment\_refuter module --------------------------------------------------------- @@ -68,6 +92,22 @@ dowhy.causal\_refuters.random\_common\_cause module :undoc-members: :show-inheritance: +dowhy.causal\_refuters.refute\_estimate module +---------------------------------------------- + +.. automodule:: dowhy.causal_refuters.refute_estimate + :members: + :undoc-members: + :show-inheritance: + +dowhy.causal\_refuters.reisz module +----------------------------------- + +.. automodule:: dowhy.causal_refuters.reisz + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/source/dowhy.gcm.independence_test.rst b/docs/source/dowhy.gcm.independence_test.rst index e50f01299d..88e23c14d7 100644 --- a/docs/source/dowhy.gcm.independence_test.rst +++ b/docs/source/dowhy.gcm.independence_test.rst @@ -4,6 +4,14 @@ dowhy.gcm.independence\_test package Submodules ---------- +dowhy.gcm.independence\_test.generalised\_cov\_measure module +------------------------------------------------------------- + +.. automodule:: dowhy.gcm.independence_test.generalised_cov_measure + :members: + :undoc-members: + :show-inheritance: + dowhy.gcm.independence\_test.kernel module ------------------------------------------ diff --git a/docs/source/dowhy.gcm.ml.rst b/docs/source/dowhy.gcm.ml.rst index 6f1d9b4919..7c27b01c43 100644 --- a/docs/source/dowhy.gcm.ml.rst +++ b/docs/source/dowhy.gcm.ml.rst @@ -4,6 +4,14 @@ dowhy.gcm.ml package Submodules ---------- +dowhy.gcm.ml.autolguon module +----------------------------- + +.. automodule:: dowhy.gcm.ml.autolguon + :members: + :undoc-members: + :show-inheritance: + dowhy.gcm.ml.classification module ---------------------------------- diff --git a/docs/source/dowhy.gcm.rst b/docs/source/dowhy.gcm.rst index 474fd1c7cc..be6748d71a 100644 --- a/docs/source/dowhy.gcm.rst +++ b/docs/source/dowhy.gcm.rst @@ -190,6 +190,14 @@ dowhy.gcm.uncertainty module :undoc-members: :show-inheritance: +dowhy.gcm.unit\_change module +----------------------------- + +.. automodule:: dowhy.gcm.unit_change + :members: + :undoc-members: + :show-inheritance: + dowhy.gcm.validation module --------------------------- diff --git a/docs/source/dowhy.rst b/docs/source/dowhy.rst index 84bea1ad77..c8e87af9c8 100644 --- a/docs/source/dowhy.rst +++ b/docs/source/dowhy.rst @@ -9,7 +9,7 @@ Subpackages dowhy.api dowhy.causal_estimators - dowhy.causal_identifiers + dowhy.causal_identifier dowhy.causal_refuters dowhy.data_transformers dowhy.do_samplers @@ -37,14 +37,6 @@ dowhy.causal\_graph module :undoc-members: :show-inheritance: -dowhy.causal\_identifier module -------------------------------- - -.. automodule:: dowhy.causal_identifier - :members: - :undoc-members: - :show-inheritance: - dowhy.causal\_model module -------------------------- diff --git a/docs/source/dowhy.utils.rst b/docs/source/dowhy.utils.rst index 4a8732e3d0..df153e4402 100644 --- a/docs/source/dowhy.utils.rst +++ b/docs/source/dowhy.utils.rst @@ -60,6 +60,14 @@ dowhy.utils.propensity\_score module :undoc-members: :show-inheritance: +dowhy.utils.regression module +----------------------------- + +.. automodule:: dowhy.utils.regression + :members: + :undoc-members: + :show-inheritance: + Module contents ---------------