Merge pull request #206 from DoubleML/dev

Update workflows and Release Notes for 0.9.2

Author: SvenKlaassen

.github/workflows/deploy_docu_dev.yml

@@ -36,7 +36,7 @@ jobs:
         pip install -r requirements.txt
         pip uninstall -y DoubleML
         cd doubleml-for-py
-        pip install -e .
+        pip install -e .[rdd]
 
     - name: Add R repository
       run: |

.github/workflows/test_build_docu_dev.yml

@@ -63,7 +63,7 @@ jobs:
         pip install -r requirements.txt
         pip uninstall -y DoubleML
         cd doubleml-for-py
-        pip install -e .
+        pip install -e .[rdd]
 
     - name: Add R repository
       run: |

doc/examples/py_double_ml_rdflex.ipynb

@@ -15,6 +15,13 @@
     "with $Y_i(1)$ and $Y_i(0)$ denoting the potential outcomes of an individual with and without treatment, respectively."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**Note:** The dependencies for the module ``doubleml.rdd`` can be installed seperately via ``pip install rdrobust``, if necessary."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,

doc/intro/install.rst

@@ -17,6 +17,10 @@ There are three different ways to install the python package :ref:`DoubleML <dou
 - Install a released version of DoubleML from a .whl file.
 - Building the package from source. This is recommended if you want to work with the latest development version of the package. This also the best way if you wish to contribute to DoubleML.
 
+.. note::
+    Since DoubleML 0.9.2, some dependencies are installed optionally. For details, please read the instructions below.
+
+
 Python: Installing the latest release from pip or conda
 -------------------------------------------------------
 
@@ -313,6 +317,17 @@ Python: Installing the latest release from pip or conda
 
 
 
+Python: Optional Dependencies
+-----------------------------
+
+In all installation procedures specified above, the dependencies required for the ``doubleml.rdd`` module as well as
+the package development requirements are not included in the installation. Please use ``pip install doubleml[rdd]``, ``pip install doubleml[dev]``
+or ``pip install doubleml[dev,rdd]`` to install the necessary requirements for these modules, if desired.
+
+.. note::
+    The dependency ``rdrobust`` required in the ``doubleml.rdd`` module is currently not available on conda-forge.
+
+
 Python: Installing a released version from a .whl file
 ------------------------------------------------------
 
@@ -345,13 +360,6 @@ re-interpreted when the python interpreter restarts without having to re-build t
 
     $ pip install --editable .
 
-An alternative to pip with the ``--editable`` flag is the ``develope`` mode of setuptools. To use it call
-
-.. code-block:: Bash
-
-    $ python setup.py develop
-
-
 .. _install_r:
 
 R: Installing DoubleML

doc/release/release.rst

@@ -7,6 +7,22 @@ Release notes
 
   .. tab-item:: Python
 
+    .. dropdown:: DoubleML 0.9.2
+      :class-title: sd-bg-primary sd-font-weight-bold
+      :open:
+
+      - Make `rdrobust` optional for conda. Create `pyproject.toml` and remove `setup.py` for packaging
+        `#285 <https://github.com/DoubleML/doubleml-for-py/pull/285>`_
+        `#286 <https://github.com/DoubleML/doubleml-for-py/pull/286>`_
+
+      - Maintenance package
+        `#284 <https://github.com/DoubleML/doubleml-for-py/pull/284>`_
+
+      - Maintenance doccumentation
+        `#205 <https://github.com/DoubleML/doubleml-docs/pull/205>`_
+        `#206 <https://github.com/DoubleML/doubleml-docs/pull/206>`_
+        `#207 <https://github.com/DoubleML/doubleml-docs/pull/207>`_
+    
     .. dropdown:: DoubleML 0.9.1
       :class-title: sd-bg-primary sd-font-weight-bold
       :open:
@@ -26,7 +42,7 @@ Release notes
       - Add AutoML example for tuning DoubleML estimators
         `#199 <https://github.com/DoubleML/doubleml-docs/pull/199>`_
 
-      - Maintainance package
+      - Maintenance package
         `#268 <https://github.com/DoubleML/doubleml-for-py/pull/268>`_
         `#278 <https://github.com/DoubleML/doubleml-for-py/issues/278>`_
         `#279 <https://github.com/DoubleML/doubleml-for-py/pull/279>`_
@@ -39,7 +55,6 @@ Release notes
 
     .. dropdown:: DoubleML 0.9.0
       :class-title: sd-bg-primary sd-font-weight-bold
-      :open:
 
       - **Release highlight:** Average potential outcomes for multiple discrete treatments
         via ``DoubleMLAPO`` and ``DoubleMLAPOS`` classes (proposed by `Apoorva Lal <https://github.com/apoorvalal>`_)
@@ -53,7 +68,7 @@ Release notes
       - Add sensitivity analysis to ``DoubleMLFramework``
         `#249 <https://github.com/DoubleML/doubleml-for-py/pull/249>`_
 
-      - Maintainance package
+      - Maintenance package
         `#264 <https://github.com/DoubleML/doubleml-for-py/pull/264>`_
         `#265 <https://github.com/DoubleML/doubleml-for-py/pull/265>`_
         `#266 <https://github.com/DoubleML/doubleml-for-py/pull/266>`_
@@ -87,7 +102,7 @@ Release notes
       - Update the ``make_confounded_irm_data`` data generating process
         `#263 <https://github.com/DoubleML/doubleml-for-py/pull/263>`_
 
-      - Maintainance package
+      - Maintenance package
         `#264 <https://github.com/DoubleML/doubleml-for-py/pull/264>`_
 
       - Maintenance documentation
@@ -108,7 +123,7 @@ Release notes
         `#173 <https://github.com/DoubleML/doubleml-docs/pull/173>`_
         `#174 <https://github.com/DoubleML/doubleml-docs/pull/174>`_
 
-      - Maintainance documentation
+      - Maintenance documentation
         `#172 <https://github.com/DoubleML/doubleml-docs/pull/172>`_
 
     .. dropdown:: DoubleML 0.8.0
@@ -140,7 +155,7 @@ Release notes
         `#167 <https://github.com/DoubleML/doubleml-docs/pull/167>`_
         `#168 <https://github.com/DoubleML/doubleml-docs/pull/168>`_
 
-      - Maintainance package
+      - Maintenance package
         `#225 <https://github.com/DoubleML/doubleml-for-py/pull/225>`_
         `#229 <https://github.com/DoubleML/doubleml-for-py/pull/229>`_
         `#246 <https://github.com/DoubleML/doubleml-for-py/pull/246>`_

doc/shared/models/rdd.rst

@@ -13,6 +13,9 @@ Let :math:`Y_i` be the observed outcome of an individual and :math:`D_i` the tre
     - :math:`D_i` the **treatment received** (in sharp RDD instead of :math:`T_i`)
     - :math:`T_i` the **treatment assigned** (only relevant in fuzzy RDD)
 
+.. note::
+   The ``doubleml.rdd`` module depends on ``rdrobust`` which can be installed via ``pip install rdrobust`` or ``pip install doubleml[rdd]``.
+
 Sharp Regression Discontinuity Design
 *************************************
 

requirements.txt

@@ -1,4 +1,4 @@
-DoubleML
+DoubleML[rdd]
 
 # test
 pytest
@@ -20,4 +20,3 @@ seaborn
 xgboost
 lightgbm
 flaml
-rdrobust