Skip to content

Commit

Permalink
modified: docs/dsm_api.html
Browse files Browse the repository at this point in the history
	modified:   docs/dsm_torch.html
	modified:   docs/losses.html
  • Loading branch information
chiragnagpal authored and texchi2 committed Jan 23, 2021
1 parent 2302bc6 commit 8880249
Show file tree
Hide file tree
Showing 3 changed files with 198 additions and 22 deletions.
88 changes: 75 additions & 13 deletions docs/dsm_api.html
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,28 @@ <h2 id="parameters">Parameters</h2>
<dd>random seed that determines how the validation set is chosen.</dd>
</dl></div>
</dd>
<dt id="dsm.dsm_api.DeepSurvivalMachines.predict_mean"><code class="name flex">
<span>def <span class="ident">predict_mean</span></span>(<span>self, x, risk=1)</span>
</code></dt>
<dd>
<p class="inheritance">
<em>Inherited from:</em>
<code><a title="dsm.dsm_api.DSMBase" href="#dsm.dsm_api.DSMBase">DSMBase</a></code>.<code><a title="dsm.dsm_api.DSMBase.predict_mean" href="#dsm.dsm_api.DSMBase.predict_mean">predict_mean</a></code>
</p>
<div class="desc"><p>Returns the mean Time-to-Event <span><span class="MathJax_Preview"> t </span><script type="math/tex"> t </script></span></p>
<h2 id="parameters">Parameters</h2>
<dl>
<dt><strong><code>x</code></strong> :&ensp;<code>np.ndarray</code></dt>
<dd>A numpy array of the input features, <span><span class="MathJax_Preview"> x </span><script type="math/tex"> x </script></span>.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>np.array</code></dt>
<dd>numpy array of the mean time to event.</dd>
</dl></div>
</dd>
<dt id="dsm.dsm_api.DeepSurvivalMachines.predict_risk"><code class="name flex">
<span>def <span class="ident">predict_risk</span></span>(<span>self, x, t)</span>
<span>def <span class="ident">predict_risk</span></span>(<span>self, x, t, risk=1)</span>
</code></dt>
<dd>
<p class="inheritance">
Expand All @@ -140,7 +160,7 @@ <h2 id="returns">Returns</h2>
</dl></div>
</dd>
<dt id="dsm.dsm_api.DeepSurvivalMachines.predict_survival"><code class="name flex">
<span>def <span class="ident">predict_survival</span></span>(<span>self, x, t)</span>
<span>def <span class="ident">predict_survival</span></span>(<span>self, x, t, risk=1)</span>
</code></dt>
<dd>
<p class="inheritance">
Expand Down Expand Up @@ -211,8 +231,28 @@ <h2 id="parameters">Parameters</h2>
<dd>random seed that determines how the validation set is chosen.</dd>
</dl></div>
</dd>
<dt id="dsm.dsm_api.DeepRecurrentSurvivalMachines.predict_mean"><code class="name flex">
<span>def <span class="ident">predict_mean</span></span>(<span>self, x, risk=1)</span>
</code></dt>
<dd>
<p class="inheritance">
<em>Inherited from:</em>
<code><a title="dsm.dsm_api.DSMBase" href="#dsm.dsm_api.DSMBase">DSMBase</a></code>.<code><a title="dsm.dsm_api.DSMBase.predict_mean" href="#dsm.dsm_api.DSMBase.predict_mean">predict_mean</a></code>
</p>
<div class="desc"><p>Returns the mean Time-to-Event <span><span class="MathJax_Preview"> t </span><script type="math/tex"> t </script></span></p>
<h2 id="parameters">Parameters</h2>
<dl>
<dt><strong><code>x</code></strong> :&ensp;<code>np.ndarray</code></dt>
<dd>A numpy array of the input features, <span><span class="MathJax_Preview"> x </span><script type="math/tex"> x </script></span>.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>np.array</code></dt>
<dd>numpy array of the mean time to event.</dd>
</dl></div>
</dd>
<dt id="dsm.dsm_api.DeepRecurrentSurvivalMachines.predict_risk"><code class="name flex">
<span>def <span class="ident">predict_risk</span></span>(<span>self, x, t)</span>
<span>def <span class="ident">predict_risk</span></span>(<span>self, x, t, risk=1)</span>
</code></dt>
<dd>
<p class="inheritance">
Expand All @@ -236,7 +276,7 @@ <h2 id="returns">Returns</h2>
</dl></div>
</dd>
<dt id="dsm.dsm_api.DeepRecurrentSurvivalMachines.predict_survival"><code class="name flex">
<span>def <span class="ident">predict_survival</span></span>(<span>self, x, t)</span>
<span>def <span class="ident">predict_survival</span></span>(<span>self, x, t, risk=1)</span>
</code></dt>
<dd>
<p class="inheritance">
Expand All @@ -263,12 +303,11 @@ <h2 id="returns">Returns</h2>
</dd>
<dt id="dsm.dsm_api.DeepConvolutionalSurvivalMachines"><code class="flex name class">
<span>class <span class="ident">DeepConvolutionalSurvivalMachines</span></span>
<span>(</span><span>k=3, layers=None, hidden=None, distribution='Weibull', temp=1000.0, discount=1.0, typ='LSTM')</span>
<span>(</span><span>k=3, layers=None, hidden=None, distribution='Weibull', temp=1000.0, discount=1.0, typ='ConvNet')</span>
</code></dt>
<dd>
<div class="desc"><div class="admonition warning">
<p class="admonition-title">Warning:&ensp;Not Implemented</p>
</div></div>
<div class="desc"><p>The Deep Convolutional Survival Machines model to handle data with
image-based covariates.</p></div>
<h3>Methods</h3>
<dl>
<dt id="dsm.dsm_api.DeepConvolutionalSurvivalMachines.fit"><code class="name flex">
Expand All @@ -277,7 +316,7 @@ <h3>Methods</h3>
<dd>
<p class="inheritance">
<em>Inherited from:</em>
<code><a title="dsm.dsm_api.DeepRecurrentSurvivalMachines" href="#dsm.dsm_api.DeepRecurrentSurvivalMachines">DeepRecurrentSurvivalMachines</a></code>.<code><a title="dsm.dsm_api.DeepRecurrentSurvivalMachines.fit" href="#dsm.dsm_api.DeepRecurrentSurvivalMachines.fit">fit</a></code>
<code><a title="dsm.dsm_api.DSMBase" href="#dsm.dsm_api.DSMBase">DSMBase</a></code>.<code><a title="dsm.dsm_api.DSMBase.fit" href="#dsm.dsm_api.DSMBase.fit">fit</a></code>
</p>
<div class="desc"><p>This method is used to train an instance of the DSM model.</p>
<h2 id="parameters">Parameters</h2>
Expand Down Expand Up @@ -308,13 +347,33 @@ <h2 id="parameters">Parameters</h2>
<dd>random seed that determines how the validation set is chosen.</dd>
</dl></div>
</dd>
<dt id="dsm.dsm_api.DeepConvolutionalSurvivalMachines.predict_mean"><code class="name flex">
<span>def <span class="ident">predict_mean</span></span>(<span>self, x, risk=1)</span>
</code></dt>
<dd>
<p class="inheritance">
<em>Inherited from:</em>
<code><a title="dsm.dsm_api.DSMBase" href="#dsm.dsm_api.DSMBase">DSMBase</a></code>.<code><a title="dsm.dsm_api.DSMBase.predict_mean" href="#dsm.dsm_api.DSMBase.predict_mean">predict_mean</a></code>
</p>
<div class="desc"><p>Returns the mean Time-to-Event <span><span class="MathJax_Preview"> t </span><script type="math/tex"> t </script></span></p>
<h2 id="parameters">Parameters</h2>
<dl>
<dt><strong><code>x</code></strong> :&ensp;<code>np.ndarray</code></dt>
<dd>A numpy array of the input features, <span><span class="MathJax_Preview"> x </span><script type="math/tex"> x </script></span>.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>np.array</code></dt>
<dd>numpy array of the mean time to event.</dd>
</dl></div>
</dd>
<dt id="dsm.dsm_api.DeepConvolutionalSurvivalMachines.predict_risk"><code class="name flex">
<span>def <span class="ident">predict_risk</span></span>(<span>self, x, t)</span>
<span>def <span class="ident">predict_risk</span></span>(<span>self, x, t, risk=1)</span>
</code></dt>
<dd>
<p class="inheritance">
<em>Inherited from:</em>
<code><a title="dsm.dsm_api.DeepRecurrentSurvivalMachines" href="#dsm.dsm_api.DeepRecurrentSurvivalMachines">DeepRecurrentSurvivalMachines</a></code>.<code><a title="dsm.dsm_api.DeepRecurrentSurvivalMachines.predict_risk" href="#dsm.dsm_api.DeepRecurrentSurvivalMachines.predict_risk">predict_risk</a></code>
<code><a title="dsm.dsm_api.DSMBase" href="#dsm.dsm_api.DSMBase">DSMBase</a></code>.<code><a title="dsm.dsm_api.DSMBase.predict_risk" href="#dsm.dsm_api.DSMBase.predict_risk">predict_risk</a></code>
</p>
<div class="desc"><p>Returns the estimated risk of an event occuring before time <span><span class="MathJax_Preview"> t </span><script type="math/tex"> t </script></span>
<span><span class="MathJax_Preview"> \widehat{\mathbb{P}}(T\leq t|X) </span><script type="math/tex"> \widehat{\mathbb{P}}(T\leq t|X) </script></span> for some input data <span><span class="MathJax_Preview"> x </span><script type="math/tex"> x </script></span>.</p>
Expand All @@ -333,12 +392,12 @@ <h2 id="returns">Returns</h2>
</dl></div>
</dd>
<dt id="dsm.dsm_api.DeepConvolutionalSurvivalMachines.predict_survival"><code class="name flex">
<span>def <span class="ident">predict_survival</span></span>(<span>self, x, t)</span>
<span>def <span class="ident">predict_survival</span></span>(<span>self, x, t, risk=1)</span>
</code></dt>
<dd>
<p class="inheritance">
<em>Inherited from:</em>
<code><a title="dsm.dsm_api.DeepRecurrentSurvivalMachines" href="#dsm.dsm_api.DeepRecurrentSurvivalMachines">DeepRecurrentSurvivalMachines</a></code>.<code><a title="dsm.dsm_api.DeepRecurrentSurvivalMachines.predict_survival" href="#dsm.dsm_api.DeepRecurrentSurvivalMachines.predict_survival">predict_survival</a></code>
<code><a title="dsm.dsm_api.DSMBase" href="#dsm.dsm_api.DSMBase">DSMBase</a></code>.<code><a title="dsm.dsm_api.DSMBase.predict_survival" href="#dsm.dsm_api.DSMBase.predict_survival">predict_survival</a></code>
</p>
<div class="desc"><p>Returns the estimated survival probability at time <span><span class="MathJax_Preview"> t </span><script type="math/tex"> t </script></span>,
<span><span class="MathJax_Preview"> \widehat{\mathbb{P}}(T &gt; t|X) </span><script type="math/tex"> \widehat{\mathbb{P}}(T > t|X) </script></span> for some input data <span><span class="MathJax_Preview"> x </span><script type="math/tex"> x </script></span>.</p>
Expand Down Expand Up @@ -378,6 +437,7 @@ <h1>Index</h1>
<h4><code><a title="dsm.dsm_api.DeepSurvivalMachines" href="#dsm.dsm_api.DeepSurvivalMachines">DeepSurvivalMachines</a></code></h4>
<ul class="">
<li><code><a title="dsm.dsm_api.DeepSurvivalMachines.fit" href="#dsm.dsm_api.DeepSurvivalMachines.fit">fit</a></code></li>
<li><code><a title="dsm.dsm_api.DeepSurvivalMachines.predict_mean" href="#dsm.dsm_api.DeepSurvivalMachines.predict_mean">predict_mean</a></code></li>
<li><code><a title="dsm.dsm_api.DeepSurvivalMachines.predict_risk" href="#dsm.dsm_api.DeepSurvivalMachines.predict_risk">predict_risk</a></code></li>
<li><code><a title="dsm.dsm_api.DeepSurvivalMachines.predict_survival" href="#dsm.dsm_api.DeepSurvivalMachines.predict_survival">predict_survival</a></code></li>
</ul>
Expand All @@ -386,6 +446,7 @@ <h4><code><a title="dsm.dsm_api.DeepSurvivalMachines" href="#dsm.dsm_api.DeepSur
<h4><code><a title="dsm.dsm_api.DeepRecurrentSurvivalMachines" href="#dsm.dsm_api.DeepRecurrentSurvivalMachines">DeepRecurrentSurvivalMachines</a></code></h4>
<ul class="">
<li><code><a title="dsm.dsm_api.DeepRecurrentSurvivalMachines.fit" href="#dsm.dsm_api.DeepRecurrentSurvivalMachines.fit">fit</a></code></li>
<li><code><a title="dsm.dsm_api.DeepRecurrentSurvivalMachines.predict_mean" href="#dsm.dsm_api.DeepRecurrentSurvivalMachines.predict_mean">predict_mean</a></code></li>
<li><code><a title="dsm.dsm_api.DeepRecurrentSurvivalMachines.predict_risk" href="#dsm.dsm_api.DeepRecurrentSurvivalMachines.predict_risk">predict_risk</a></code></li>
<li><code><a title="dsm.dsm_api.DeepRecurrentSurvivalMachines.predict_survival" href="#dsm.dsm_api.DeepRecurrentSurvivalMachines.predict_survival">predict_survival</a></code></li>
</ul>
Expand All @@ -394,6 +455,7 @@ <h4><code><a title="dsm.dsm_api.DeepRecurrentSurvivalMachines" href="#dsm.dsm_ap
<h4><code><a title="dsm.dsm_api.DeepConvolutionalSurvivalMachines" href="#dsm.dsm_api.DeepConvolutionalSurvivalMachines">DeepConvolutionalSurvivalMachines</a></code></h4>
<ul class="">
<li><code><a title="dsm.dsm_api.DeepConvolutionalSurvivalMachines.fit" href="#dsm.dsm_api.DeepConvolutionalSurvivalMachines.fit">fit</a></code></li>
<li><code><a title="dsm.dsm_api.DeepConvolutionalSurvivalMachines.predict_mean" href="#dsm.dsm_api.DeepConvolutionalSurvivalMachines.predict_mean">predict_mean</a></code></li>
<li><code><a title="dsm.dsm_api.DeepConvolutionalSurvivalMachines.predict_risk" href="#dsm.dsm_api.DeepConvolutionalSurvivalMachines.predict_risk">predict_risk</a></code></li>
<li><code><a title="dsm.dsm_api.DeepConvolutionalSurvivalMachines.predict_survival" href="#dsm.dsm_api.DeepConvolutionalSurvivalMachines.predict_survival">predict_survival</a></code></li>
</ul>
Expand Down
Loading

0 comments on commit 8880249

Please sign in to comment.