Skip to content

Add documentation for the non-linear score mixin class #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 29 commits into from
Feb 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
d4a559e
add documentation for non-linear score mixin class
MalteKurz Sep 16, 2022
870722c
add example notebook for gate and cate
SvenKlaassen Nov 2, 2022
2a96735
Merge branch 'master' into s-notebook-CATE
SvenKlaassen Nov 2, 2022
3b1554f
add details to CATE and GATE notebooks
SvenKlaassen Nov 4, 2022
8bb1846
Merge branch 'main' into s-notebook-CATE
SvenKlaassen Nov 4, 2022
9fe5b8a
add thumbnails
SvenKlaassen Nov 4, 2022
250d239
add true effect
SvenKlaassen Nov 4, 2022
70d6750
Merge branch 'main' into s-notebook-CATE
SvenKlaassen Nov 4, 2022
92b6f1e
Merge branch 'main' of github.com:DoubleML/doubleml-docs into m-nonli…
MalteKurz Nov 4, 2022
a07c46d
add plotly to requirements for 3d plots
SvenKlaassen Nov 4, 2022
7b1adcf
fix broken ectj link
SvenKlaassen Nov 4, 2022
ba3f505
add thumbnails
SvenKlaassen Nov 7, 2022
cc4a090
adapt docu to work with the score mixin class(es)
MalteKurz Nov 15, 2022
3bc532d
Merge branch 'main' of github.com:DoubleML/doubleml-docs into m-nonli…
MalteKurz Nov 23, 2022
bc82d00
add summary to GATE and CATE example
SvenKlaassen Dec 8, 2022
bfa7482
Merge branch 'main' into s-notebook-CATE
SvenKlaassen Jan 4, 2023
2df35b4
clean nbs
SvenKlaassen Jan 4, 2023
1064c55
Merge branch 'main' into s-notebook-CATE
SvenKlaassen Jan 11, 2023
af7b626
Merge branch 'main' into s-notebook-CATE
PhilippBach Jan 11, 2023
2dcd859
Update resampling.rst
SvenKlaassen Jan 11, 2023
33b2b43
Update resampling.rst
SvenKlaassen Jan 11, 2023
3adf3bf
Merge pull request #116 from DoubleML/s-notebook-CATE
SvenKlaassen Jan 11, 2023
42e935e
PhilippBach Jan 23, 2023
cd0ed8a
Merge branch 'main' into p-fix-pension-example
PhilippBach Jan 23, 2023
6897fde
Merge pull request #120 from DoubleML/p-fix-pension-example
PhilippBach Jan 23, 2023
ceec03c
PhilippBach Feb 13, 2023
4b318f8
PhilippBach Feb 13, 2023
afc437e
Merge pull request #122 from DoubleML/p-fix-getstarted
PhilippBach Feb 14, 2023
4930300
Merge remote-tracking branch 'origin/dev' into m-nonlinear-score-mixin
PhilippBach Feb 16, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
*.idea

8 changes: 8 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions .idea/doubleml-docs.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/inspectionProfiles/profiles_settings.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions .idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions .idea/rGraphicsSettings.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/rSettings.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 13 additions & 1 deletion doc/api/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,16 @@ Dataset generators
datasets.make_irm_data
datasets.make_iivm_data
datasets.make_plr_turrell2018
datasets.make_pliv_multiway_cluster_CKMS2021
datasets.make_pliv_multiway_cluster_CKMS2021

Score mixin classes for double machine learning models
------------------------------------------------------

.. currentmodule:: doubleml

.. autosummary::
:toctree: generated/
:template: class.rst

double_ml_score_mixins.LinearScoreMixin
double_ml_score_mixins.NonLinearScoreMixin
1 change: 1 addition & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@
'https://doi.org/10.1111/ectj.12097', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.2307/2171802', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.2307/1912705', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1093/ectj/utaa027', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
]

# To execute R code via jupyter-execute one needs to install the R kernel for jupyter
Expand Down
2 changes: 1 addition & 1 deletion doc/examples/R_double_ml_pension.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1141,7 +1141,7 @@
},
"source": [
"These estimates that flexibly account for confounding are\n",
"substantially attenuated relative to the baseline estimate (*19559*) that does not account for confounding. They suggest much smaller causal effects of 401(k) eligiblity on financial asset holdings. The best model with lowest RMSE in both equations is the PLR model estimated via lasso. It gives the following estimate:"
"substantially attenuated relative to the baseline estimate (*19559*) that does not account for confounding. They suggest much smaller causal effects of 401(k) eligiblity on financial asset holdings."
]
},
{
Expand Down
2 changes: 2 additions & 0 deletions doc/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ These are case studies with the Python package :ref:`DoubleML <doubleml_package>

py_double_ml_pension.ipynb
py_double_ml_multiway_cluster.ipynb
py_double_ml_gate.ipynb
py_double_ml_cate.ipynb

|start-h3| Sandbox |end-h3|

Expand Down
Loading