Skip to content

Add Documentation to rdd module #204

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 36 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
fc4f8fb
add rdd.rst
OliverSchacht Oct 7, 2024
46de31d
update doc
OliverSchacht Oct 8, 2024
6a2485c
add example notebook, work in progress
OliverSchacht Oct 8, 2024
8f86242
Update py_double_ml_rdflex.ipynb
OliverSchacht Oct 22, 2024
2803eda
update (still draft)
OliverSchacht Oct 22, 2024
63817be
Update py_double_ml_rdflex.ipynb
SvenKlaassen Oct 22, 2024
a24c9df
Merge branch 'o-add-rdd' of https://github.com/DoubleML/doubleml-docs…
SvenKlaassen Oct 22, 2024
f9cd0dd
add rdd
OliverSchacht Oct 23, 2024
8da75d2
finish rdd docu
OliverSchacht Oct 23, 2024
690e783
add implementation details
OliverSchacht Oct 23, 2024
7655275
Update rdd.rst
OliverSchacht Oct 23, 2024
5fc6095
Merge branch 'dev' into o-add-rdd
OliverSchacht Oct 23, 2024
c1721ab
add rdrobust to requirements
OliverSchacht Oct 23, 2024
8cadf92
fix example in rdd,rst
OliverSchacht Oct 23, 2024
ffd64a3
apparently sphinx does not like multi line code
OliverSchacht Oct 23, 2024
126c549
add rdd literature
OliverSchacht Oct 24, 2024
223d1a9
add rdd example
OliverSchacht Oct 24, 2024
1ff3ada
revision
OliverSchacht Oct 24, 2024
7ae7964
fix broken links
OliverSchacht Oct 24, 2024
b3d0433
add cattaneo link to exceptions
OliverSchacht Oct 25, 2024
ff18f88
add rdd api
OliverSchacht Nov 13, 2024
2054bed
revision according to feedback
OliverSchacht Nov 13, 2024
d0dec8f
revision according to feedback
OliverSchacht Nov 13, 2024
38d5f21
fix argmin
OliverSchacht Nov 14, 2024
9589cbc
add non-adj learner
OliverSchacht Nov 14, 2024
95999a9
typos
OliverSchacht Nov 14, 2024
ce1a72c
Update py_double_ml_rdflex.ipynb
OliverSchacht Nov 15, 2024
81b5ddf
Merge branch 'dev' into o-add-rdd
OliverSchacht Nov 15, 2024
cc4fea9
remove rdd anchor in example
OliverSchacht Nov 15, 2024
0d93f97
clear outputs
OliverSchacht Nov 18, 2024
ee970c2
small fix
OliverSchacht Nov 18, 2024
078cd00
move RDD out of DoubleML section
OliverSchacht Nov 19, 2024
4ec9471
Update example
OliverSchacht Nov 19, 2024
b657cdf
minor corrections
OliverSchacht Nov 19, 2024
d9f8acd
final comments
OliverSchacht Dec 2, 2024
0cbd6c6
Update conf.py
OliverSchacht Dec 2, 2024
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
11 changes: 11 additions & 0 deletions doc/api/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,16 @@ Double machine learning models
DoubleMLCVAR
DoubleMLQTE

Other models
------------------------------
.. currentmodule:: doubleml

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

rdd.RDFlex

Datasets module
---------------

Expand Down Expand Up @@ -73,6 +83,7 @@ Dataset generators
datasets.make_confounded_irm_data
datasets.make_heterogeneous_data
datasets.make_irm_data_discrete_treatments
rdd.datasets.make_simple_rdd_data

Utility classes and functions
-----------------------------
Expand Down
4 changes: 4 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,10 @@
'http://dx.doi.org/10.2139/ssrn.3619201',
# Valid URL, Causes ConnectTimeoutError
'https://folia.unifr.ch/global/documents/306524',
# Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1146/annurev-economics-051520-021409',
# Valdi DOI; Causes 504 Server Error: Gateway Time-out for ...
'https://doi.org/10.1017/CBO9781139060035.008'
]

# To execute R code via jupyter-execute one needs to install the R kernel for jupyter
Expand Down
1 change: 1 addition & 0 deletions doc/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ General Examples
py_double_ml_basic_iv.ipynb
py_double_ml_plm_irm_hetfx.ipynb
py_double_ml_meets_flaml.ipynb
py_double_ml_rdflex.ipynb


Effect Heterogeneity
Expand Down
Loading
Loading