Skip to content

Fix typos in docstrings & update authors #266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SvenKlaassen merged 2 commits into from
Aug 30, 2024
Merged

Fix typos in docstrings & update authors #266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03b40c5
update docstring make_irm_data_discrete_treatments
SvenKlaassen Aug 30, 2024
05f1cc4
update maintainer and authors
SvenKlaassen Aug 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
# -- Project information -----------------------------------------------------

project = 'DoubleML'
copyright = '2021, Bach, P., Chernozhukov, V., Kurz, M. S., and Spindler, M.'
author = 'Bach, P., Chernozhukov, V., Kurz, M. S., and Spindler, M.'
copyright = '2021, Bach, P., Chernozhukov, V., Klaassen, S., Kurz, M. S., and Spindler, M.'
author = 'Bach, P., Chernozhukov, V., Klaassen, S., Kurz, M. S., and Spindler, M.'

# The full version, including alpha/beta/rc tags
release = '0.9.dev0'
Expand Down
6 changes: 4 additions & 2 deletions doubleml/datasets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1523,7 +1523,7 @@ def make_irm_data_discrete_treatments(n_obs=200, n_levels=3, linear=False, rando

.. math::

\\text{\\theta}(d) = 0.1 \\exp(d) + 10 \\sin(0.7 d) + 2 d - 0.2 d^2.
\\theta (d) = 0.1 \\exp(d) + 10 \\sin(0.7 d) + 2 d - 0.2 d^2.

Based on the continous treatment, a discrete treatment :math:`D` is generated as with a baseline level of
:math:`D=0` and additional levels based on the quantiles of :math:`D_{\\text{cont}}`. The number of levels
Expand All @@ -1535,7 +1535,7 @@ def make_irm_data_discrete_treatments(n_obs=200, n_levels=3, linear=False, rando

Y(0) &= 210 + 27.4 Z_1 + 13.7 (Z_2 + Z_3 + Z_4) + \\varepsilon_Y

Y(1) &= \\text{\\theta}(D_{\\text{cont}}) 1\\{D_{\\text{cont}} > 0\\} + Y(0),
Y(1) &= \\theta (D_{\\text{cont}}) 1\\{D_{\\text{cont}} > 0\\} + Y(0),

where :math:`\\varepsilon_Y \\sim \\mathcal{N}(0,5)`. Further, the observed outcome is defined as

Expand Down Expand Up @@ -1567,6 +1567,8 @@ def make_irm_data_discrete_treatments(n_obs=200, n_levels=3, linear=False, rando
-------
res_dict : dictionary
Dictionary with entries ``x``, ``y``, ``d`` and ``oracle_values``.
The oracle values contain the continuous treatment, the level bounds, the potential level, ITE
and the potential outcome without treatment.

"""
if random_state is not None:
Expand Down
6 changes: 3 additions & 3 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
setup(
name='DoubleML',
version='0.9.dev0',
author='Bach, P., Chernozhukov, V., Kurz, M. S., and Spindler, M.',
maintainer='Malte S. Kurz',
maintainer_email='malte.simon.kurz@uni-hamburg.de',
author='Bach, P., Chernozhukov, V., Klaassen, S., Kurz, M. S., and Spindler, M.',
maintainer='Sven Klaassen',
maintainer_email='sven.klaassen@uni-hamburg.de',
description='Double Machine Learning in Python',
long_description=long_description,
long_description_content_type='text/markdown',
Expand Down