Merge pull request #251 from DoubleML/s-update-data

Update Docs for datasets and data classes

Author: SvenKlaassen

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,21 @@ 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_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/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",

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)."
    ]

doc/examples/did/py_panel.ipynb

@@ -50,7 +50,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "n_obs = 5000\n",
+    "n_obs = 10000\n",
     "n_periods = 6\n",
     "\n",
     "df = make_did_cs_CS2021(n_obs, dgp_type=4, include_never_treated=True, n_periods=n_periods, n_pre_treat_periods=3,\n",
@@ -951,7 +951,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "dml_dev",
+   "display_name": ".venv",
    "language": "python",
    "name": "python3"
   },
@@ -965,7 +965,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.8"
+   "version": "3.12.3"
   }
  },
  "nbformat": 4,

doc/examples/did/py_panel_simple.ipynb

@@ -186,7 +186,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": ".venv",
    "language": "python",
    "name": "python3"
   },
@@ -200,7 +200,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.5"
+   "version": "3.12.3"
   }
  },
  "nbformat": 4,