Merge pull request #257 from DoubleML/dev

Update Documentation for 0.11.0

Author: SvenKlaassen

.devcontainer/Dockerfile.dev

@@ -62,7 +62,7 @@ COPY --chown=$USERNAME:$USERNAME requirements.txt /tmp/requirements.txt
 RUN python -m venv /home/$USERNAME/.venv && \
     /home/$USERNAME/.venv/bin/python -m pip install --upgrade pip && \
     /home/$USERNAME/.venv/bin/pip install --no-cache-dir -r /tmp/requirements.txt && \
-    /home/$USERNAME/.venv/bin/pip install --no-cache-dir git+https://github.com/DoubleML/doubleml-for-py.git@main#egg=DoubleML[rdd]
+    /home/$USERNAME/.venv/bin/pip install --no-cache-dir "DoubleML[rdd] @ git+https://github.com/DoubleML/doubleml-for-py.git@main"
 
 # Set the virtual environment as the default Python environment
 ENV PATH="/home/$USERNAME/.venv/bin:$PATH"

doc/api/data_class.rst

@@ -12,3 +12,6 @@ DoubleML Data Class
     DoubleMLData
     DoubleMLClusterData
     DoubleMLPanelData
+    DoubleMLSSMData
+    DoubleMLRDDData
+    DoubleMLDIDData

doc/api/datasets.rst

@@ -6,13 +6,13 @@ Datasets
 Dataset Loaders
 ~~~~~~~~~~~~~~~
 
-.. currentmodule:: doubleml
+.. currentmodule:: doubleml.datasets
 
 .. autosummary::
    :toctree: generated/
 
-   datasets.fetch_401K
-   datasets.fetch_bonus
+   fetch_401K
+   fetch_bonus
 
 Dataset Generators
 ~~~~~~~~~~~~~~~~~~
@@ -22,18 +22,22 @@ Dataset Generators
 .. autosummary::
    :toctree: generated/
 
-   datasets.make_plr_CCDDHNR2018
-   datasets.make_pliv_CHS2015
-   datasets.make_irm_data
-   datasets.make_iivm_data
-   datasets.make_plr_turrell2018
-   datasets.make_pliv_multiway_cluster_CKMS2021
-
-   datasets.make_ssm_data
-   datasets.make_confounded_plr_data
-   datasets.make_confounded_irm_data
-   datasets.make_heterogeneous_data
-   datasets.make_irm_data_discrete_treatments
+   irm.datasets.make_irm_data
+   irm.datasets.make_iivm_data
+   irm.datasets.make_heterogeneous_data
+   irm.datasets.make_irm_data_discrete_treatments
+   irm.datasets.make_confounded_irm_data
+   irm.datasets.make_ssm_data
+
+   plm.datasets.make_plr_CCDDHNR2018
+   plm.datasets.make_plr_turrell2018
+   plm.datasets.make_lplr_LZZ2020
+   plm.datasets.make_pliv_CHS2015
+   plm.datasets.make_pliv_multiway_cluster_CKMS2021
+   plm.datasets.make_confounded_plr_data
+
    did.datasets.make_did_SZ2020
    did.datasets.make_did_CS2021
-   rdd.datasets.make_simple_rdd_data
+   did.datasets.make_did_cs_CS2021
+
+   rdd.datasets.make_simple_rdd_data

doc/api/dml_models.rst

@@ -16,6 +16,7 @@ doubleml.plm
     :template: class.rst
 
     DoubleMLPLR
+    DoubleMLLPLR
     DoubleMLPLIV
 
 

doc/api/utility.rst

@@ -18,6 +18,8 @@ Utility Classes
     utils.DoubleMLPolicyTree
     utils.GlobalRegressor
     utils.GlobalClassifier
+    utils.PSProcessorConfig
+    utils.PSProcessor
 
 Utility Functions
 ~~~~~~~~~~~~~~~~~

doc/conf.py

@@ -94,8 +94,8 @@
     "navbar_align": "left",
     "logo": {
         "text": project,
-        "image_light": "img/logo.png",
-        "image_dark": "img/logo_dark.png",
+        "image_light": "../img/logo.png",
+        "image_dark": "../img/logo_dark.png",
     },
     "header_links_before_dropdown": 6,
     "use_edit_page_button": True,
@@ -133,6 +133,7 @@
 html_favicon = "../img/favicon.ico"
 
 html_sidebars = {
+    
     "**": [
         "logo.html",
         "search-field.html",
@@ -273,6 +274,8 @@
     "https://doi.org/10.1097%2FEDE.0b013e3181f74493",
     # Valid DOI; Causes 403 Client Error: Forbidden for url:...
     "https://doi.org/10.3982/ECTA15732",
+    # Valid DOI; Causes 403 Client Error: Forbidden for url:...
+    "https://doi.org/10.1093/ectj/utab019"
 ]
 
 # To execute R code via jupyter-execute one needs to install the R kernel for jupyter

doc/examples/did/py_did.ipynb

@@ -367,6 +367,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "np.random.seed(42)\n",
     "dml_obj = DoubleMLDIDMulti(dml_data, **default_args)\n",
     "dml_obj.fit()\n",
     "print(dml_obj)"

doc/examples/did/py_did_pretest.ipynb

@@ -250,7 +250,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Event Study Aggregation\n",
+    "### Event Study Aggregation\n",
     "\n",
     "Finally, `aggregation=\"eventstudy\"` aggregates $\\widehat{ATT}(\\mathrm{g},t_\\text{pre},t_\\text{eval})$ based on exposure time $e = t_\\text{eval} - \\mathrm{g}$ (respecting group size)."
    ]