Skip to content

Commit 9e938f3

Browse files
amit-sharmaamit-sharma
authored
[Version Bump v0.9] Release notes and updated docstrings (#778)
* release notes and updated docstrings Signed-off-by: Amit Sharma <[email protected]> * updated title Signed-off-by: Amit Sharma <[email protected]> * updated changes Signed-off-by: Amit Sharma <[email protected]> * added github username Signed-off-by: Amit Sharma <[email protected]> Signed-off-by: Amit Sharma <[email protected]>
1 parent 649b3c3 commit 9e938f3

8 files changed

+181
-9
lines changed

‎docs/source/code_repo.rst

+47
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,53 @@ DoWhy is hosted on GitHub.
66
You can browse the code in a html-friendly format `here
77
<https://github.com/Microsoft/dowhy>`_.
88

9+
v0.9: New functional API (preview), faster refutations, and better independence tests for GCMs
10+
----------------------------------------------------------------------------------------------
11+
December 5 2022
12+
13+
* Preview for the new functional API (see `notebook <https://github.com/py-why/dowhy/blob/main/docs/source/example_notebooks/dowhy_functional_api.ipynb>`_). 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)
14+
15+
* Faster, better sensitivity analyses.
16+
* Many refutations now support joblib for parallel processing and show a progress bar (@astoeffelbauer, @yemaedahrav).
17+
* Non-linear sensitivity analysis [`Chernozhukov, Cinelli, Newey, Sharma & Syrgkanis (2021) <https://arxiv.org/abs/2112.13398>`_, `example notebook <https://github.com/py-why/dowhy/blob/main/docs/source/example_notebooks/sensitivity_analysis_nonparametric_estimators.ipynb>`_] (@anusha0409)
18+
* E-value sensitivity analysis [`Ding & Vanderweele (2016) <https://www.ncbi.nlm.nih.gov/pmc/articles/PMC4820664/>`, `example notebook <https://github.com/py-why/dowhy/blob/main/docs/source/example_notebooks/sensitivity_analysis_testing.ipynb>`_] (@jlgleason)
19+
20+
* New API for unit change attribution (@kailashbuki)
21+
22+
* New quality option `BEST` for auto-assignment of causal mechanisms, which uses the optional auto-ML library AutoGluon (@bloebp)
23+
24+
* Better conditional independence tests through the causal-learn package (@bloebp)
25+
26+
* Algorithms for computing efficient backdoor sets [`example notebook <https://github.com/py-why/dowhy/blob/main/docs/source/example_notebooks/dowhy_efficient_backdoor_example.ipynb>`_] (@esmucler)
27+
28+
* Support for estimating controlled direct effect (@amit-sharma)
29+
30+
* Support for multi-valued treatments for econml estimators (@EgorKraevTransferwise)
31+
32+
* New PyData theme for documentation with new homepage, Getting started guide, revised User Guide and examples page (@petergtz)
33+
34+
* A `contributing guide <https://github.com/py-why/dowhy/blob/main/docs/source/contributing/contributing-code.rst>`_ and simplified instructions for new contributors (@MichaelMarien)
35+
36+
* Streamlined dev environment using Poetry for managing dependencies and project builds (@darthtrevino)
37+
38+
* Bug fixes
39+
40+
v0.8: GCM support and partial R2-based sensitivity analysis
41+
-------------------------------------------------------------
42+
July 18 2022
43+
44+
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.
45+
46+
* **Graphical Causal Models**: SCMs, root-cause analysis, attribution, what-if analysis, and more.
47+
48+
* **Sensitivity Analysis**: Faster, more general partial-R2 based sensitivity analysis for linear models, based on `Cinelli & Hazlett (2020) <https://rss.onlinelibrary.wiley.com/doi/10.1111/rssb.12348>`_.
49+
50+
* **New docs structure**: Updated docs structure including user and contributors' guide. Check out the `docs <https://py-why.github.io/dowhy/>`_.
51+
52+
* Bug fixes
53+
54+
**Contributors**: @amit-sharma, @anusha0409, @bloebp, @EgorKraevTransferwise, @elikling, @kailashbuki, @itsoum, @MichaelMarien, @petergtz, @ryanrussell
55+
956
v0.7.1: Added Graph refuter. Support for dagitty graphs and external estimators
1057
--------------------------------------------------------------------------------------
1158

‎docs/source/dowhy.causal_identifier.rst

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
dowhy.causal\_identifier package
2+
================================
3+
4+
Submodules
5+
----------
6+
7+
dowhy.causal\_identifier.auto\_identifier module
8+
------------------------------------------------
9+
10+
.. automodule:: dowhy.causal_identifier.auto_identifier
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
dowhy.causal\_identifier.backdoor module
16+
----------------------------------------
17+
18+
.. automodule:: dowhy.causal_identifier.backdoor
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
dowhy.causal\_identifier.efficient\_backdoor module
24+
---------------------------------------------------
25+
26+
.. automodule:: dowhy.causal_identifier.efficient_backdoor
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
dowhy.causal\_identifier.id\_identifier module
32+
----------------------------------------------
33+
34+
.. automodule:: dowhy.causal_identifier.id_identifier
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
dowhy.causal\_identifier.identified\_estimand module
40+
----------------------------------------------------
41+
42+
.. automodule:: dowhy.causal_identifier.identified_estimand
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
dowhy.causal\_identifier.identify\_effect module
48+
------------------------------------------------
49+
50+
.. automodule:: dowhy.causal_identifier.identify_effect
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
Module contents
56+
---------------
57+
58+
.. automodule:: dowhy.causal_identifier
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:

‎docs/source/dowhy.causal_refuters.rst

+40
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,14 @@ dowhy.causal\_refuters.dummy\_outcome\_refuter module
3636
:undoc-members:
3737
:show-inheritance:
3838

39+
dowhy.causal\_refuters.evalue\_sensitivity\_analyzer module
40+
-----------------------------------------------------------
41+
42+
.. automodule:: dowhy.causal_refuters.evalue_sensitivity_analyzer
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
3947
dowhy.causal\_refuters.graph\_refuter module
4048
--------------------------------------------
4149

@@ -52,6 +60,22 @@ dowhy.causal\_refuters.linear\_sensitivity\_analyzer module
5260
:undoc-members:
5361
:show-inheritance:
5462

63+
dowhy.causal\_refuters.non\_parametric\_sensitivity\_analyzer module
64+
--------------------------------------------------------------------
65+
66+
.. automodule:: dowhy.causal_refuters.non_parametric_sensitivity_analyzer
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
dowhy.causal\_refuters.partial\_linear\_sensitivity\_analyzer module
72+
--------------------------------------------------------------------
73+
74+
.. automodule:: dowhy.causal_refuters.partial_linear_sensitivity_analyzer
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
5579
dowhy.causal\_refuters.placebo\_treatment\_refuter module
5680
---------------------------------------------------------
5781

@@ -68,6 +92,22 @@ dowhy.causal\_refuters.random\_common\_cause module
6892
:undoc-members:
6993
:show-inheritance:
7094

95+
dowhy.causal\_refuters.refute\_estimate module
96+
----------------------------------------------
97+
98+
.. automodule:: dowhy.causal_refuters.refute_estimate
99+
:members:
100+
:undoc-members:
101+
:show-inheritance:
102+
103+
dowhy.causal\_refuters.reisz module
104+
-----------------------------------
105+
106+
.. automodule:: dowhy.causal_refuters.reisz
107+
:members:
108+
:undoc-members:
109+
:show-inheritance:
110+
71111
Module contents
72112
---------------
73113

‎docs/source/dowhy.gcm.independence_test.rst

+8
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ dowhy.gcm.independence\_test package
44
Submodules
55
----------
66

7+
dowhy.gcm.independence\_test.generalised\_cov\_measure module
8+
-------------------------------------------------------------
9+
10+
.. automodule:: dowhy.gcm.independence_test.generalised_cov_measure
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
715
dowhy.gcm.independence\_test.kernel module
816
------------------------------------------
917

‎docs/source/dowhy.gcm.ml.rst

+8
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ dowhy.gcm.ml package
44
Submodules
55
----------
66

7+
dowhy.gcm.ml.autolguon module
8+
-----------------------------
9+
10+
.. automodule:: dowhy.gcm.ml.autolguon
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
715
dowhy.gcm.ml.classification module
816
----------------------------------
917

‎docs/source/dowhy.gcm.rst

+8
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,14 @@ dowhy.gcm.uncertainty module
190190
:undoc-members:
191191
:show-inheritance:
192192

193+
dowhy.gcm.unit\_change module
194+
-----------------------------
195+
196+
.. automodule:: dowhy.gcm.unit_change
197+
:members:
198+
:undoc-members:
199+
:show-inheritance:
200+
193201
dowhy.gcm.validation module
194202
---------------------------
195203

‎docs/source/dowhy.rst

+1-9
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Subpackages
99

1010
dowhy.api
1111
dowhy.causal_estimators
12-
dowhy.causal_identifiers
12+
dowhy.causal_identifier
1313
dowhy.causal_refuters
1414
dowhy.data_transformers
1515
dowhy.do_samplers
@@ -37,14 +37,6 @@ dowhy.causal\_graph module
3737
:undoc-members:
3838
:show-inheritance:
3939

40-
dowhy.causal\_identifier module
41-
-------------------------------
42-
43-
.. automodule:: dowhy.causal_identifier
44-
:members:
45-
:undoc-members:
46-
:show-inheritance:
47-
4840
dowhy.causal\_model module
4941
--------------------------
5042

‎docs/source/dowhy.utils.rst

+8
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,14 @@ dowhy.utils.propensity\_score module
6060
:undoc-members:
6161
:show-inheritance:
6262

63+
dowhy.utils.regression module
64+
-----------------------------
65+
66+
.. automodule:: dowhy.utils.regression
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
6371
Module contents
6472
---------------
6573

0 commit comments

Comments
 (0)