306 refactor data generators

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -23,12 +23,10 @@ body:
     attributes:
       label: Minimum reproducible code snippet
       description: |
-        Please provide a short reproducible code snippet. Example:
-
-        ```python
+        Please provide a short reproducible code snippet. Example:        ```python
         import numpy as np
         import doubleml as dml
-        from doubleml.datasets import make_plr_CCDDHNR2018
+        from doubleml.plm.datasets import make_plr_CCDDHNR2018
         from sklearn.ensemble import RandomForestRegressor
         from sklearn.base import clone
         np.random.seed(3141)

CONTRIBUTING.md

@@ -15,7 +15,7 @@ To submit a **bug report**, you can use our
 ```python
 import numpy as np
 import doubleml as dml
-from doubleml.datasets import make_plr_CCDDHNR2018
+from doubleml.plm.datasets import make_plr_CCDDHNR2018
 from sklearn.ensemble import RandomForestRegressor
 from sklearn.base import clone
 np.random.seed(3141)

doubleml/data/base_data.py

@@ -135,9 +135,8 @@ class DoubleMLData(DoubleMLBaseData):
         Default is ``True``.
 
     Examples
-    --------
-    >>> from doubleml import DoubleMLData
-    >>> from doubleml.datasets import make_plr_CCDDHNR2018
+    --------    >>> from doubleml import DoubleMLData
+    >>> from doubleml.plm.datasets import make_plr_CCDDHNR2018
     >>> # initialization from pandas.DataFrame
     >>> df = make_plr_CCDDHNR2018(return_type='DataFrame')
     >>> obj_dml_data_from_df = DoubleMLData(df, 'y', 'd')
@@ -266,9 +265,8 @@ def from_arrays(
             Default is ``True``.
 
         Examples
-        --------
-        >>> from doubleml import DoubleMLData
-        >>> from doubleml.datasets import make_plr_CCDDHNR2018
+        --------        >>> from doubleml import DoubleMLData
+        >>> from doubleml.plm.datasets import make_plr_CCDDHNR2018
         >>> (x, y, d) = make_plr_CCDDHNR2018(return_type='array')
         >>> obj_dml_data_from_array = DoubleMLData.from_arrays(x, y, d)
         """

doubleml/data/cluster_data.py

@@ -61,9 +61,8 @@ class DoubleMLClusterData(DoubleMLData):
         Default is ``True``.
 
     Examples
-    --------
-    >>> from doubleml import DoubleMLClusterData
-    >>> from doubleml.datasets import make_pliv_multiway_cluster_CKMS2021
+    --------    >>> from doubleml import DoubleMLClusterData
+    >>> from doubleml.plm.datasets import make_pliv_multiway_cluster_CKMS2021
     >>> # initialization from pandas.DataFrame
     >>> df = make_pliv_multiway_cluster_CKMS2021(return_type='DataFrame')
     >>> obj_dml_data_from_df = DoubleMLClusterData(df, 'Y', 'D', ['cluster_var_i', 'cluster_var_j'], z_cols='Z')
@@ -172,9 +171,8 @@ def from_arrays(
             Default is ``True``.
 
         Examples
-        --------
-        >>> from doubleml import DoubleMLClusterData
-        >>> from doubleml.datasets import make_pliv_multiway_cluster_CKMS2021
+        --------        >>> from doubleml import DoubleMLClusterData
+        >>> from doubleml.plm.datasets import make_pliv_multiway_cluster_CKMS2021
         >>> (x, y, d, cluster_vars, z) = make_pliv_multiway_cluster_CKMS2021(return_type='array')
         >>> obj_dml_data_from_array = DoubleMLClusterData.from_arrays(x, y, d, cluster_vars, z)
         """

doubleml/data/tests/conftest.py

@@ -2,7 +2,8 @@
 import pandas as pd
 import pytest
 
-from doubleml.datasets import make_irm_data, make_plr_turrell2018
+from doubleml.irm.datasets import make_irm_data
+from doubleml.plm.datasets import make_plr_turrell2018
 
 
 @pytest.fixture(scope="session", params=[(500, 10), (1000, 20), (1000, 100)])

doubleml/data/tests/test_cluster_data.py

@@ -3,7 +3,7 @@
 import pytest
 
 from doubleml import DoubleMLClusterData
-from doubleml.datasets import make_pliv_multiway_cluster_CKMS2021, make_plr_CCDDHNR2018
+from doubleml.plm.datasets import make_pliv_multiway_cluster_CKMS2021, make_plr_CCDDHNR2018
 
 
 @pytest.mark.ci

doubleml/data/tests/test_dml_data.py

@@ -5,12 +5,12 @@
 
 from doubleml import DoubleMLData, DoubleMLDIDCS, DoubleMLPLR, DoubleMLSSM
 from doubleml.data.base_data import DoubleMLBaseData
-from doubleml.datasets import (
+from doubleml.plm.datasets import (
     _make_pliv_data,
     make_pliv_CHS2015,
     make_plr_CCDDHNR2018,
-    make_ssm_data,
 )
+from doubleml.irm.datasets import make_ssm_data
 from doubleml.did.datasets import make_did_SZ2020