Skip to content

Commit 19869d8

Browse files
committed
deploy: e4fb68d
1 parent 05479e6 commit 19869d8

10 files changed

Lines changed: 1307 additions & 1548 deletions

File tree

_modules/dte_adj.html

Lines changed: 0 additions & 1474 deletions
This file was deleted.

_modules/dte_adj/local.html

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

_modules/dte_adj/plot.html

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,6 @@ <h3>Related Topics</h3>
136136
<ul>
137137
<li><a href="../../index.html">Documentation overview</a><ul>
138138
<li><a href="../index.html">Module code</a><ul>
139-
<li><a href="../dte_adj.html">dte_adj</a><ul>
140-
</ul></li>
141139
</ul></li>
142140
</ul></li>
143141
</ul>

_modules/dte_adj/simple.html

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

_modules/dte_adj/stratified.html

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

_modules/index.html

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,11 @@
3030
<div class="body" role="main">
3131

3232
<h1>All modules for which code is available</h1>
33-
<ul><li><a href="dte_adj.html">dte_adj</a></li>
34-
<ul><li><a href="dte_adj/plot.html">dte_adj.plot</a></li>
35-
</ul></ul>
33+
<ul><li><a href="dte_adj/local.html">dte_adj.local</a></li>
34+
<li><a href="dte_adj/plot.html">dte_adj.plot</a></li>
35+
<li><a href="dte_adj/simple.html">dte_adj.simple</a></li>
36+
<li><a href="dte_adj/stratified.html">dte_adj.stratified</a></li>
37+
</ul>
3638

3739
</div>
3840

api/local.html

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

api/simple.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ <h1>Simple Randomization Estimators<a class="headerlink" href="#simple-randomiza
4747
<h2>SimpleDistributionEstimator<a class="headerlink" href="#simpledistributionestimator" title="Link to this heading"></a></h2>
4848
<dl class="py class">
4949
<dt class="sig sig-object py">
50-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dte_adj.</span></span><span class="sig-name descname"><span class="pre">SimpleDistributionEstimator</span></span><a class="reference internal" href="../_modules/dte_adj.html#SimpleDistributionEstimator"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
50+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dte_adj.</span></span><span class="sig-name descname"><span class="pre">SimpleDistributionEstimator</span></span><a class="reference internal" href="../_modules/dte_adj/simple.html#SimpleDistributionEstimator"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
5151
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">SimpleStratifiedDistributionEstimator</span></code></p>
5252
<p>A class for computing the empirical distribution function and distributional treatment effects
5353
using simple (unadjusted) estimation methods.</p>
@@ -76,7 +76,7 @@ <h2>SimpleDistributionEstimator<a class="headerlink" href="#simpledistributiones
7676
</div>
7777
<dl class="py method">
7878
<dt class="sig sig-object py">
79-
<span class="sig-name descname"><span class="pre">fit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">covariates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">treatment_arms</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outcomes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">SimpleDistributionEstimator</span></span></span><a class="reference internal" href="../_modules/dte_adj.html#SimpleDistributionEstimator.fit"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
79+
<span class="sig-name descname"><span class="pre">fit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">covariates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">treatment_arms</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outcomes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">SimpleDistributionEstimator</span></span></span><a class="reference internal" href="../_modules/dte_adj/simple.html#SimpleDistributionEstimator.fit"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
8080
<dd><p>Set parameters.</p>
8181
<dl class="field-list simple">
8282
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -311,7 +311,7 @@ <h2>SimpleDistributionEstimator<a class="headerlink" href="#simpledistributiones
311311
<h2>AdjustedDistributionEstimator<a class="headerlink" href="#adjusteddistributionestimator" title="Link to this heading"></a></h2>
312312
<dl class="py class">
313313
<dt class="sig sig-object py">
314-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dte_adj.</span></span><span class="sig-name descname"><span class="pre">AdjustedDistributionEstimator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_multi_task</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/dte_adj.html#AdjustedDistributionEstimator"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
314+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dte_adj.</span></span><span class="sig-name descname"><span class="pre">AdjustedDistributionEstimator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_multi_task</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/dte_adj/simple.html#AdjustedDistributionEstimator"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
315315
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">AdjustedStratifiedDistributionEstimator</span></code></p>
316316
<p>A class for computing distribution treatment effects using machine learning adjustment.</p>
317317
<p>This estimator uses cross-fitting with ML models to adjust for confounding when computing
@@ -341,7 +341,7 @@ <h2>AdjustedDistributionEstimator<a class="headerlink" href="#adjusteddistributi
341341
</div>
342342
<dl class="py method">
343343
<dt class="sig sig-object py">
344-
<span class="sig-name descname"><span class="pre">fit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">covariates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">treatment_arms</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outcomes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">AdjustedDistributionEstimator</span></span></span><a class="reference internal" href="../_modules/dte_adj.html#AdjustedDistributionEstimator.fit"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
344+
<span class="sig-name descname"><span class="pre">fit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">covariates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">treatment_arms</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outcomes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">AdjustedDistributionEstimator</span></span></span><a class="reference internal" href="../_modules/dte_adj/simple.html#AdjustedDistributionEstimator.fit"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
345345
<dd><p>Set parameters.</p>
346346
<dl class="field-list simple">
347347
<dt class="field-odd">Parameters<span class="colon">:</span></dt>

api/stratified.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ <h1>Covariate Adaptive Randomization Estimators<a class="headerlink" href="#cova
4747
<h2>SimpleStratifiedDistributionEstimator<a class="headerlink" href="#simplestratifieddistributionestimator" title="Link to this heading"></a></h2>
4848
<dl class="py class">
4949
<dt class="sig sig-object py">
50-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dte_adj.</span></span><span class="sig-name descname"><span class="pre">SimpleStratifiedDistributionEstimator</span></span><a class="reference internal" href="../_modules/dte_adj.html#SimpleStratifiedDistributionEstimator"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
50+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dte_adj.</span></span><span class="sig-name descname"><span class="pre">SimpleStratifiedDistributionEstimator</span></span><a class="reference internal" href="../_modules/dte_adj/stratified.html#SimpleStratifiedDistributionEstimator"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
5151
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DistributionEstimatorBase</span></code></p>
5252
<p>A class is for estimating the empirical distribution function and computing the Distributional parameters for CAR.</p>
5353
<dl class="py method">
5454
<dt class="sig sig-object py">
55-
<span class="sig-name descname"><span class="pre">fit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">covariates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">treatment_arms</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outcomes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">DistributionEstimatorBase</span></span></span><a class="reference internal" href="../_modules/dte_adj.html#SimpleStratifiedDistributionEstimator.fit"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
55+
<span class="sig-name descname"><span class="pre">fit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">covariates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">treatment_arms</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outcomes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">DistributionEstimatorBase</span></span></span><a class="reference internal" href="../_modules/dte_adj/stratified.html#SimpleStratifiedDistributionEstimator.fit"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
5656
<dd><p>Train the DistributionEstimatorBase.</p>
5757
<dl class="field-list simple">
5858
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -287,12 +287,12 @@ <h2>SimpleStratifiedDistributionEstimator<a class="headerlink" href="#simplestra
287287
<h2>AdjustedStratifiedDistributionEstimator<a class="headerlink" href="#adjustedstratifieddistributionestimator" title="Link to this heading"></a></h2>
288288
<dl class="py class">
289289
<dt class="sig sig-object py">
290-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dte_adj.</span></span><span class="sig-name descname"><span class="pre">AdjustedStratifiedDistributionEstimator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_multi_task</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/dte_adj.html#AdjustedStratifiedDistributionEstimator"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
290+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dte_adj.</span></span><span class="sig-name descname"><span class="pre">AdjustedStratifiedDistributionEstimator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_multi_task</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/dte_adj/stratified.html#AdjustedStratifiedDistributionEstimator"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
291291
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DistributionEstimatorBase</span></code></p>
292292
<p>A class is for estimating the adjusted distribution function and computing the Distributional parameters for CAR.</p>
293293
<dl class="py method">
294294
<dt class="sig sig-object py">
295-
<span class="sig-name descname"><span class="pre">fit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">covariates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">treatment_arms</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outcomes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">DistributionEstimatorBase</span></span></span><a class="reference internal" href="../_modules/dte_adj.html#AdjustedStratifiedDistributionEstimator.fit"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
295+
<span class="sig-name descname"><span class="pre">fit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">covariates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">treatment_arms</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outcomes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">DistributionEstimatorBase</span></span></span><a class="reference internal" href="../_modules/dte_adj/stratified.html#AdjustedStratifiedDistributionEstimator.fit"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
296296
<dd><p>Train the DistributionEstimatorBase.</p>
297297
<dl class="field-list simple">
298298
<dt class="field-odd">Parameters<span class="colon">:</span></dt>

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)