Skip to content

Commit 579056e

Browse files
committed
deploy: 1feb8aa
1 parent 9152aad commit 579056e

28 files changed

Lines changed: 2266 additions & 2258 deletions

_images/distributional_effect.png

145 KB
Loading

_modules/dte_adj.html

Lines changed: 26 additions & 26 deletions
Large diffs are not rendered by default.

_modules/dte_adj/plot.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ <h1>Source code for dte_adj.plot</h1><div class="highlight"><pre>
3838

3939

4040
<div class="viewcode-block" id="plot">
41-
<a class="viewcode-back" href="../../modules.html#dte_adj.plot.plot">[docs]</a>
41+
<a class="viewcode-back" href="../../api/plot.html#dte_adj.plot.plot">[docs]</a>
4242
<span class="k">def</span><span class="w"> </span><span class="nf">plot</span><span class="p">(</span>
4343
<span class="n">X</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
4444
<span class="n">means</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
@@ -135,8 +135,8 @@ <h1 class="logo"><a href="../../index.html">dte_adj</a></h1>
135135
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
136136
<ul>
137137
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation Guide</a></li>
138-
<li class="toctree-l1"><a class="reference internal" href="../../get_started.html">Get Started with dte_adj</a></li>
139-
<li class="toctree-l1"><a class="reference internal" href="../../modules.html">Modules</a></li>
138+
<li class="toctree-l1"><a class="reference internal" href="../../get_started.html">Get Started</a></li>
139+
<li class="toctree-l1"><a class="reference internal" href="../../api_reference.html">API Reference</a></li>
140140
<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contribution Guide</a></li>
141141
</ul>
142142

_modules/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ <h1 class="logo"><a href="../index.html">dte_adj</a></h1>
6363
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
6464
<ul>
6565
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation Guide</a></li>
66-
<li class="toctree-l1"><a class="reference internal" href="../get_started.html">Get Started with dte_adj</a></li>
67-
<li class="toctree-l1"><a class="reference internal" href="../modules.html">Modules</a></li>
66+
<li class="toctree-l1"><a class="reference internal" href="../get_started.html">Get Started</a></li>
67+
<li class="toctree-l1"><a class="reference internal" href="../api_reference.html">API Reference</a></li>
6868
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contribution Guide</a></li>
6969
</ul>
7070

_sources/api/local.rst.txt

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Local Distribution Estimators
2+
==============================
3+
4+
This page documents local distribution treatment effect estimators that compute treatment effects weighted by treatment propensity within each stratum. These estimators are particularly useful for handling treatment assignment heterogeneity across strata.
5+
6+
SimpleLocalDistributionEstimator
7+
--------------------------------
8+
9+
.. autoclass:: dte_adj.SimpleLocalDistributionEstimator
10+
:members:
11+
:undoc-members:
12+
:show-inheritance:
13+
:no-index:
14+
15+
AdjustedLocalDistributionEstimator
16+
----------------------------------
17+
18+
.. autoclass:: dte_adj.AdjustedLocalDistributionEstimator
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
:no-index:

_sources/api/plot.rst.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Plotting Utilities
2+
==================
3+
4+
This page documents plotting utilities for visualizing distribution treatment effects, confidence intervals, and other results.
5+
6+
.. automodule:: dte_adj.plot
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:
10+
:no-index:

_sources/api/simple.rst.txt

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Simple Randomization Estimators
2+
===============================
3+
4+
This page documents estimators that work with simple randomized experimental designs where treatment assignment is completely randomized.
5+
6+
These estimators leverage pre-treatment covariates through distributional regression frameworks to improve the precision of distributional treatment effect estimates. The key methodological contribution is using machine learning techniques for variance reduction while maintaining validity as long as nuisance components are reasonably well estimated.
7+
8+
Byambadalai et al. (2024) [#simple2024]_ propose a regression adjustment method that incorporates covariates into distributional regression, enabling deeper insights beyond average treatment effects by estimating full distributional treatment effects in randomized experiments.
9+
10+
.. [#simple2024] Byambadalai, U., Oka, T., & Yasui, S. (2024). Estimating Distributional Treatment Effects in Randomized Experiments: Machine Learning for Variance Reduction. arXiv preprint `arXiv:2407.16037 <https://arxiv.org/abs/2407.16037>`_.
11+
12+
SimpleDistributionEstimator
13+
---------------------------
14+
15+
.. autoclass:: dte_adj.SimpleDistributionEstimator
16+
:members:
17+
:inherited-members:
18+
:undoc-members:
19+
:show-inheritance:
20+
:no-index:
21+
22+
AdjustedDistributionEstimator
23+
-----------------------------
24+
25+
.. autoclass:: dte_adj.AdjustedDistributionEstimator
26+
:members:
27+
:inherited-members:
28+
:undoc-members:
29+
:show-inheritance:
30+
:no-index:

_sources/api/stratified.rst.txt

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Covariate Adaptive Randomization Estimators
2+
===========================================
3+
4+
This page documents estimators that work with stratified experimental designs, particularly for covariate-adaptive randomization (CAR) within strata.
5+
6+
These estimators are designed to handle stratified block randomization where participants are grouped into strata based on baseline covariates before treatment assignment. The key methodological contribution is leveraging additional covariates beyond strata indicators using machine learning methods to enhance the precision of distributional treatment effect estimates.
7+
8+
Byambadalai et al. (2025) [#car2025]_ propose a flexible distribution regression framework that achieves the semiparametric efficiency bound for distributional treatment effects under CAR, demonstrating that regression-adjusted estimators can optimally utilize covariate information in stratified designs.
9+
10+
.. [#car2025] Byambadalai, U., Hirata, T., Oka, T., & Yasui, S. (2025). On Efficient Estimation of Distributional Treatment Effects under Covariate-Adaptive Randomization. arXiv preprint `arXiv:2506.05945 <https://arxiv.org/abs/2506.05945>`_.
11+
12+
SimpleStratifiedDistributionEstimator
13+
-------------------------------------
14+
15+
.. autoclass:: dte_adj.SimpleStratifiedDistributionEstimator
16+
:members:
17+
:inherited-members:
18+
:undoc-members:
19+
:show-inheritance:
20+
:no-index:
21+
22+
AdjustedStratifiedDistributionEstimator
23+
---------------------------------------
24+
25+
.. autoclass:: dte_adj.AdjustedStratifiedDistributionEstimator
26+
:members:
27+
:inherited-members:
28+
:undoc-members:
29+
:show-inheritance:
30+
:no-index:

_sources/api_reference.rst.txt

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
API Reference
2+
=============
3+
4+
This section provides comprehensive documentation for all classes and functions in the dte_adj package. The API is organized into logical groups based on functionality and use cases.
5+
6+
Overview
7+
--------
8+
9+
The dte_adj package provides several types of estimators for computing distribution treatment effects:
10+
11+
* **Simple Randomization Estimators**: For estimating distributional effects in simple randomized experiments where treatment assignment is independent of all covariates
12+
* **Covariate Adaptive Randomization Estimators**: For estimating distributional effects under covariate-adaptive randomization (CAR) designs, including stratified block randomization and other adaptive schemes
13+
* **Local Distribution Estimators**: For estimating local distribution treatment effects weighted by treatment propensity within strata
14+
* **Utility Functions**: Helper functions for confidence intervals and statistical computations
15+
* **Plotting Utilities**: Visualization tools for treatment effects and distributions
16+
17+
For theoretical foundations, see Byambadalai et al. (2024) [#simple2024]_ for simple randomization and Byambadalai et al. (2025) [#car2025]_ for covariate-adaptive randomization.
18+
19+
For multi-task learning approaches that train models for all locations simultaneously (using ``is_multi_task=True``), see the neural network framework in [#multitask2024]_.
20+
21+
.. [#simple2024] Byambadalai, U., Oka, T., & Yasui, S. (2024). Estimating Distributional Treatment Effects in Randomized Experiments: Machine Learning for Variance Reduction. arXiv preprint `arXiv:2407.16037 <https://arxiv.org/abs/2407.16037>`_.
22+
23+
.. [#car2025] Byambadalai, U., Hirata, T., Oka, T., & Yasui, S. (2025). On Efficient Estimation of Distributional Treatment Effects under Covariate-Adaptive Randomization. arXiv preprint `arXiv:2506.05945 <https://arxiv.org/abs/2506.05945>`_.
24+
25+
.. [#multitask2024] Byambadalai, U., Hirata, T., Oka, T., & Yasui, S. (2024). Efficient and Scalable Estimation of Distributional Treatment Effects with Multi-Task Neural Networks. arXiv preprint `arXiv:2507.07738 <https://arxiv.org/abs/2507.07738>`_.
26+
27+
Detailed Documentation
28+
----------------------
29+
30+
.. toctree::
31+
:maxdepth: 2
32+
33+
api/simple
34+
api/stratified
35+
api/local
36+
api/plot

_sources/get_started.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Get Started with dte_adj
2-
========================
1+
Get Started
2+
===========
33

44
This page contains basic usage of dte_adj library.
55

0 commit comments

Comments
 (0)