Skip to content

Commit c7d4e4a

Browse files
SvenKlaassenSvenKlaassen
committed
Merge branch 'main' into s-notebook-QTE
2 parents 3aa23fc + 293b16a commit c7d4e4a

29 files changed

+1198
-84
lines changed

‎.github/workflows/deploy_docu_dev.yml

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ name: Deploy Docu (dev)
55
on:
66
push:
77
branches:
8-
- main
8+
- dev
99
workflow_dispatch:
1010

1111

@@ -18,24 +18,19 @@ jobs:
1818

1919
steps:
2020
- name: Check out the repo containing the docu source
21-
uses: actions/checkout@v2
21+
uses: actions/checkout@v3
2222

2323
- name: Check out the repo containing the python pkg DoubleML (dev)
24-
uses: actions/checkout@v2
24+
uses: actions/checkout@v3
2525
with:
2626
repository: DoubleML/doubleml-for-py
2727
path: doubleml-for-py
2828

29-
- name: Install SSH Client for deploying the docu to github pages
30-
uses: webfactory/[email protected]
31-
with:
32-
ssh-private-key: ${{ secrets.DEPLOY_KEY }}
33-
3429
- name: Install graphviz
3530
run: sudo apt-get install graphviz
3631

3732
- name: Install python
38-
uses: actions/setup-python@v2
33+
uses: actions/setup-python@v4
3934
with:
4035
python-version: '3.8'
4136
- name: Install dependencies and the python package
@@ -69,7 +64,7 @@ jobs:
6964
shell: Rscript {0}
7065

7166
- name: Cache R packages
72-
uses: actions/cache@v2
67+
uses: actions/cache@v3
7368
with:
7469
path: ${{ env.R_LIBS_USER }}
7570
key: doubleml-user-guide-dev-${{ hashFiles('.github/R-version') }}
@@ -87,13 +82,13 @@ jobs:
8782
make -C doc html # build docu
8883
8984
- name: Deploy to dev
90-
uses: JamesIves/github-pages-deploy-action@3.7.1
85+
uses: JamesIves/github-pages-deploy-action@v4
9186
with:
92-
REPOSITORY_NAME: DoubleML/doubleml.github.io
93-
BRANCH: main
94-
FOLDER: doc/_build/html
95-
TARGET_FOLDER: dev
96-
GIT_CONFIG_NAME: DoubleML Deploy Bot
97-
GIT_CONFIG_EMAIL: [email protected]
98-
CLEAN: true
99-
SSH: true
87+
repository-name: DoubleML/doubleml.github.io
88+
branch: main
89+
folder: doc/_build/html
90+
target-folder: dev
91+
git-config-name: DoubleML Deploy Bot
92+
git-config-email: [email protected]
93+
clean: true
94+
ssh-key: ${{ secrets.DEPLOY_KEY }}

‎.github/workflows/deploy_docu_stable.yml

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,13 @@ jobs:
1313

1414
steps:
1515
- name: Check out the repo containing the docu source
16-
uses: actions/checkout@v2
17-
18-
- name: Install SSH Client for deploying the docu to github pages
19-
uses: webfactory/[email protected]
20-
with:
21-
ssh-private-key: ${{ secrets.DEPLOY_KEY }}
16+
uses: actions/checkout@v3
2217

2318
- name: Install graphviz
2419
run: sudo apt-get install graphviz
2520

2621
- name: Install python
27-
uses: actions/setup-python@v2
22+
uses: actions/setup-python@v4
2823
with:
2924
python-version: '3.8'
3025
- name: Install dependencies and the python package
@@ -55,7 +50,7 @@ jobs:
5550
shell: Rscript {0}
5651

5752
- name: Cache R packages
58-
uses: actions/cache@v2
53+
uses: actions/cache@v3
5954
with:
6055
path: ${{ env.R_LIBS_USER }}
6156
key: doubleml-user-guide-stable-${{ hashFiles('.github/R-version') }}
@@ -73,13 +68,13 @@ jobs:
7368
make -C doc html # build docu
7469
7570
- name: Deploy to stable
76-
uses: JamesIves/github-pages-deploy-action@3.7.1
71+
uses: JamesIves/github-pages-deploy-action@v4
7772
with:
78-
REPOSITORY_NAME: DoubleML/doubleml.github.io
79-
BRANCH: main
80-
FOLDER: doc/_build/html
81-
TARGET_FOLDER: stable
82-
GIT_CONFIG_NAME: DoubleML Deploy Bot
83-
GIT_CONFIG_EMAIL: [email protected]
84-
CLEAN: true
85-
SSH: true
73+
repository-name: DoubleML/doubleml.github.io
74+
branch: main
75+
folder: doc/_build/html
76+
target-folder: stable
77+
git-config-name: DoubleML Deploy Bot
78+
git-config-email: [email protected]
79+
clean: true
80+
ssh-key: ${{ secrets.DEPLOY_KEY }}

‎.github/workflows/test_build_docu_dev.yml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ on:
66
push:
77
branches:
88
- main
9+
- dev
910
pull_request:
1011
branches:
1112
- main
13+
- dev
1214
workflow_dispatch:
1315
inputs:
1416
doubleml-py-branch:
@@ -32,18 +34,18 @@ jobs:
3234

3335
steps:
3436
- name: Check out the repo containing the docu source
35-
uses: actions/checkout@v2
37+
uses: actions/checkout@v3
3638

3739
- name: Check out the repo containing the python pkg DoubleML (dev)
3840
if: ${{ github.event_name != 'workflow_dispatch' }}
39-
uses: actions/checkout@v2
41+
uses: actions/checkout@v3
4042
with:
4143
repository: DoubleML/doubleml-for-py
4244
path: doubleml-for-py
4345

4446
- name: Check out the repo containing the python pkg DoubleML (dev)
4547
if: ${{ github.event_name == 'workflow_dispatch' }}
46-
uses: actions/checkout@v2
48+
uses: actions/checkout@v3
4749
with:
4850
repository: DoubleML/doubleml-for-py
4951
path: doubleml-for-py
@@ -53,7 +55,7 @@ jobs:
5355
run: sudo apt-get install graphviz
5456

5557
- name: Install python
56-
uses: actions/setup-python@v2
58+
uses: actions/setup-python@v4
5759
with:
5860
python-version: '3.8'
5961
- name: Install dependencies and the python package
@@ -87,7 +89,7 @@ jobs:
8789
shell: Rscript {0}
8890

8991
- name: Cache R packages
90-
uses: actions/cache@v2
92+
uses: actions/cache@v3
9193
with:
9294
path: ${{ env.R_LIBS_USER }}
9395
key: doubleml-test-build-dev-${{ hashFiles('.github/R-version') }}
@@ -119,7 +121,7 @@ jobs:
119121
make -C doc linkcheck
120122
121123
- name: Upload html artifacts
122-
uses: actions/upload-artifact@v2
124+
uses: actions/upload-artifact@v3
123125
with:
124126
name: build_html
125127
path: doc/_build/html/

‎.github/workflows/test_build_docu_released.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ on:
66
push:
77
branches:
88
- main
9+
- dev
910
pull_request:
1011
branches:
1112
- main
13+
- dev
1214
workflow_dispatch:
1315
schedule:
1416
- cron: "0 9 * * 1,3,5"
@@ -21,13 +23,13 @@ jobs:
2123

2224
steps:
2325
- name: Check out the repo containing the docu source
24-
uses: actions/checkout@v2
26+
uses: actions/checkout@v3
2527

2628
- name: Install graphviz
2729
run: sudo apt-get install graphviz
2830

2931
- name: Install python
30-
uses: actions/setup-python@v2
32+
uses: actions/setup-python@v4
3133
with:
3234
python-version: '3.8'
3335
- name: Install dependencies and the python package
@@ -58,7 +60,7 @@ jobs:
5860
shell: Rscript {0}
5961

6062
- name: Cache R packages
61-
uses: actions/cache@v2
63+
uses: actions/cache@v3
6264
with:
6365
path: ${{ env.R_LIBS_USER }}
6466
key: doubleml-test-build-stable-${{ hashFiles('.github/R-version') }}
@@ -80,7 +82,7 @@ jobs:
8082
make -C doc linkcheck
8183
8284
- name: Upload html artifacts
83-
uses: actions/upload-artifact@v2
85+
uses: actions/upload-artifact@v3
8486
with:
8587
name: build_html
8688
path: doc/_build/html/

‎.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
.idea*
1+
*.idea

‎.idea/.gitignore

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/doubleml-docs.iml

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/inspectionProfiles/profiles_settings.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/misc.xml

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/modules.xml

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/rGraphicsSettings.xml

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/rSettings.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/vcs.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎doc/api/api.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,16 @@ Dataset generators
5656
datasets.make_irm_data
5757
datasets.make_iivm_data
5858
datasets.make_plr_turrell2018
59-
datasets.make_pliv_multiway_cluster_CKMS2021
59+
datasets.make_pliv_multiway_cluster_CKMS2021
60+
61+
Score mixin classes for double machine learning models
62+
------------------------------------------------------
63+
64+
.. currentmodule:: doubleml
65+
66+
.. autosummary::
67+
:toctree: generated/
68+
:template: class.rst
69+
70+
double_ml_score_mixins.LinearScoreMixin
71+
double_ml_score_mixins.NonLinearScoreMixin

‎doc/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@
129129
'https://doi.org/10.1111/ectj.12097', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
130130
'https://doi.org/10.2307/2171802', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
131131
'https://doi.org/10.2307/1912705', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
132+
'https://doi.org/10.1093/ectj/utaa027', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
132133
]
133134

134135
# To execute R code via jupyter-execute one needs to install the R kernel for jupyter

‎doc/examples/R_double_ml_pension.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1141,7 +1141,7 @@
11411141
},
11421142
"source": [
11431143
"These estimates that flexibly account for confounding are\n",
1144-
"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:"
1144+
"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."
11451145
]
11461146
},
11471147
{

‎doc/examples/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ These are case studies with the Python package :ref:`DoubleML <doubleml_package>
2424
:glob:
2525

2626
py_double_ml_pension.ipynb
27+
py_double_ml_multiway_cluster.ipynb
28+
py_double_ml_gate.ipynb
29+
py_double_ml_cate.ipynb
2730
py_double_ml_pension_qte.ipynb
28-
py_double_ml_cluster.ipynb
2931
py_double_ml_pq.ipynb
3032
py_double_ml_lpq.ipynb
3133
py_double_ml_cvar.ipynb

0 commit comments

Comments
 (0)