add api documentation for confounded data

Author: SvenKlaassen

doc/api/api.rst

@@ -64,6 +64,8 @@ Dataset generators
    datasets.make_plr_turrell2018
    datasets.make_pliv_multiway_cluster_CKMS2021
    datasets.make_did_SZ2020
+   datasets.make_confounded_plr_data
+   datasets.make_confounded_irm_data
 
 Score mixin classes for double machine learning models
 ------------------------------------------------------

doc/examples/py_double_ml_sensitivity.ipynb

@@ -5,14 +5,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Python: Sensitivity Analysis\n",
+    "# Python: DoubleSensitivity Analysis\n",
     "\n",
-    "This notebook illustrates the "
+    "This notebook illustrates the sensitivity analysis tools with the partiallly linear regression model (PLR)."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 1,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -28,25 +28,34 @@
     "from lightgbm import LGBMRegressor, LGBMClassifier\n",
     "\n",
     "import doubleml as dml\n",
-    "from doubleml.datasets import make_irm_data, make_conf_irm_data"
+    "from doubleml.datasets import make_confounded_plr_data"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "    dpg_dict = make_conf_irm_data(cf_y=cf_y, cf_d=cf_d)\n",
-    "    x_cols = [f'X{i + 1}' for i in np.arange(dpg_dict['x'].shape[1])]\n",
-    "    data = pd.DataFrame(np.column_stack((dpg_dict['x'], dpg_dict['y'], dpg_dict['d'])),\n",
-    "                                columns=x_cols + ['y', 'd'])"
-   ]
+   "source": []
   }
  ],
  "metadata": {
+  "kernelspec": {
+   "display_name": "dml_dev",
+   "language": "python",
+   "name": "python3"
+  },
   "language_info": {
-   "name": "python"
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.2"
   },
   "orig_nbformat": 4
  },

doc/guide/basics.rst

@@ -111,6 +111,7 @@ other half of observations indexed with :math:`i \in I`
             return psi_a, psi_b
 
     .. ipython:: python
+        :okwarning:
 
         from doubleml import DoubleMLData
         from doubleml import DoubleMLPLR