Skip to content

Commit

Permalink
modified: docs/datasets.html
Browse files Browse the repository at this point in the history
	modified:   docs/dsm_api.html
	modified:   docs/dsm_torch.html
	modified:   docs/index.html
	modified:   docs/losses.html
	modified:   docs/utilities.html
  • Loading branch information
chiragnagpal committed Feb 5, 2021
1 parent 23540b1 commit a2b0d8e
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/datasets.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ <h1 class="title">Module <code>dsm.datasets</code></h1>
<section id="section-intro">
<p>Utility functions to load standard datasets to train and evaluate the
Deep Survival Machines models.</p>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</section>
<section>
</section>
Expand All @@ -43,6 +44,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
</code></dt>
<dd>
<div class="desc"></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
<dt id="dsm.datasets.load_dataset"><code class="name flex">
<span>def <span class="ident">load_dataset</span></span>(<span>dataset='SUPPORT', **kwargs)</span>
Expand Down Expand Up @@ -84,13 +86,15 @@ <h2 id="returns">Returns</h2>
<dd>A tuple of the form of (x, t, e) where x, t, e are the input covariates,
event times and the censoring indicators respectively.</dd>
</dl></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<img src="https://ndownloader.figshare.com/files/26367844">
<h1>Index</h1>
<div class="toc">
<ul></ul>
Expand Down
6 changes: 6 additions & 0 deletions docs/dsm_api.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ <h1 class="title">Module <code>dsm.dsm_api</code></h1>
<section id="section-intro">
<p>This module is a wrapper around torch implementations and
provides a convenient API to train Deep Survival Machines.</p>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</section>
<section>
</section>
Expand Down Expand Up @@ -80,6 +81,7 @@ <h2 id="example">Example</h2>
&gt;&gt;&gt; model = DeepSurvivalMachines()
&gt;&gt;&gt; model.fit(x, t, e)
</code></pre></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
<h3>Methods</h3>
<dl>
<dt id="dsm.dsm_api.DeepSurvivalMachines.fit"><code class="name flex">
Expand Down Expand Up @@ -223,6 +225,7 @@ <h2 id="returns">Returns</h2>
<dd>
<div class="desc"><p>The Deep Recurrent Survival Machines model to handle data with
time-dependent covariates.</p></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
<h3>Methods</h3>
<dl>
<dt id="dsm.dsm_api.DeepRecurrentSurvivalMachines.fit"><code class="name flex">
Expand Down Expand Up @@ -366,6 +369,7 @@ <h2 id="returns">Returns</h2>
<dd>
<div class="desc"><p>The Deep Convolutional Survival Machines model to handle data with
image-based covariates.</p></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
<h3>Methods</h3>
<dl>
<dt id="dsm.dsm_api.DeepConvolutionalSurvivalMachines.fit"><code class="name flex">
Expand Down Expand Up @@ -509,6 +513,7 @@ <h2 id="returns">Returns</h2>
<dd>
<div class="desc"><p>The Deep CNN-RNN Survival Machines model to handle data with
moving image streams.</p></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
<h3>Methods</h3>
<dl>
<dt id="dsm.dsm_api.DeepCNNRNNSurvivalMachines.fit"><code class="name flex">
Expand Down Expand Up @@ -649,6 +654,7 @@ <h2 id="returns">Returns</h2>
</section>
</article>
<nav id="sidebar">
<img src="https://ndownloader.figshare.com/files/26367844">
<h1>Index</h1>
<div class="toc">
<ul></ul>
Expand Down
16 changes: 16 additions & 0 deletions docs/dsm_torch.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ <h1 class="title">Module <code>dsm.dsm_torch</code></h1>
The main interface is the DeepSurvivalMachines class which inherits
from torch.nn.Module.</p>
<p>Note: NOT DESIGNED TO BE CALLED DIRECTLY!!!</p>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</section>
<section>
</section>
Expand Down Expand Up @@ -64,6 +65,7 @@ <h2 id="parameters">Parameters</h2>
</dl>
<h2 id="returns">Returns</h2>
<p>an MLP with torch.nn.Module with the specfied structure.</p></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
<dt id="dsm.dsm_torch.create_conv_representation"><code class="name flex">
<span>def <span class="ident">create_conv_representation</span></span>(<span>inputdim, hidden, typ='ConvNet', add_linear=True)</span>
Expand All @@ -89,6 +91,7 @@ <h2 id="parameters">Parameters</h2>
</dl>
<h2 id="returns">Returns</h2>
<p>an ConvNet with torch.nn.Module with the specfied structure.</p></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
</dl>
</section>
Expand Down Expand Up @@ -141,6 +144,7 @@ <h2 id="parameters">Parameters</h2>
Default is 1.</dd>
</dl>
<p>Initializes internal Module state, shared by both nn.Module and ScriptModule.</p></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
<h3>Methods</h3>
<dl>
<dt id="dsm.dsm_torch.DeepSurvivalMachinesTorch.forward"><code class="name flex">
Expand All @@ -151,12 +155,14 @@ <h3>Methods</h3>
<h2 id="args">Args</h2>
<p>x:
a torch.tensor of the input features.</p></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
<dt id="dsm.dsm_torch.DeepSurvivalMachinesTorch.get_shape_scale"><code class="name flex">
<span>def <span class="ident">get_shape_scale</span></span>(<span>self, risk='1')</span>
</code></dt>
<dd>
<div class="desc"></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -203,6 +209,7 @@ <h2 id="parameters">Parameters</h2>
Default is 1.</dd>
</dl>
<p>Initializes internal Module state, shared by both nn.Module and ScriptModule.</p></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
<h3>Methods</h3>
<dl>
<dt id="dsm.dsm_torch.DeepRecurrentSurvivalMachinesTorch.forward"><code class="name flex">
Expand All @@ -216,12 +223,14 @@ <h3>Methods</h3>
<h2 id="args">Args</h2>
<p>x:
a torch.tensor of the input features.</p></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
<dt id="dsm.dsm_torch.DeepRecurrentSurvivalMachinesTorch.get_shape_scale"><code class="name flex">
<span>def <span class="ident">get_shape_scale</span></span>(<span>self, risk='1')</span>
</code></dt>
<dd>
<div class="desc"></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -267,6 +276,7 @@ <h2 id="parameters">Parameters</h2>
Default is 1.</dd>
</dl>
<p>Initializes internal Module state, shared by both nn.Module and ScriptModule.</p></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
<h3>Class variables</h3>
<dl>
<dt id="dsm.dsm_torch.DeepConvolutionalSurvivalMachinesTorch.dump_patches"><code class="name">var <span class="ident">dump_patches</span> : bool</code></dt>
Expand All @@ -292,12 +302,14 @@ <h3>Methods</h3>
<h2 id="args">Args</h2>
<p>x:
a torch.tensor of the input features.</p></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
<dt id="dsm.dsm_torch.DeepConvolutionalSurvivalMachinesTorch.get_shape_scale"><code class="name flex">
<span>def <span class="ident">get_shape_scale</span></span>(<span>self, risk='1')</span>
</code></dt>
<dd>
<div class="desc"></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -344,6 +356,7 @@ <h2 id="parameters">Parameters</h2>
Default is 1.</dd>
</dl>
<p>Initializes internal Module state, shared by both nn.Module and ScriptModule.</p></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
<h3>Class variables</h3>
<dl>
<dt id="dsm.dsm_torch.DeepCNNRNNSurvivalMachinesTorch.dump_patches"><code class="name">var <span class="ident">dump_patches</span> : bool</code></dt>
Expand All @@ -368,19 +381,22 @@ <h3>Methods</h3>
<h2 id="args">Args</h2>
<p>x:
a torch.tensor of the input features.</p></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
<dt id="dsm.dsm_torch.DeepCNNRNNSurvivalMachinesTorch.get_shape_scale"><code class="name flex">
<span>def <span class="ident">get_shape_scale</span></span>(<span>self, risk='1')</span>
</code></dt>
<dd>
<div class="desc"></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<img src="https://ndownloader.figshare.com/files/26367844">
<h1>Index</h1>
<div class="toc">
<ul></ul>
Expand Down
2 changes: 2 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ <h2 id="license">License</h2>
user/themes/auton/images/AutonLogo.png"></p>
<p><br><br><br><br><br>
<br><br><br><br><br></p>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</section>
<section>
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
Expand Down Expand Up @@ -195,6 +196,7 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
</section>
</article>
<nav id="sidebar">
<img src="https://ndownloader.figshare.com/files/26367844">
<h1>Index</h1>
<div class="toc">
<ul>
Expand Down
6 changes: 6 additions & 0 deletions docs/losses.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ <h1 class="title">Module <code>dsm.losses</code></h1>
<p class="admonition-title">Warning</p>
<p>NOT DESIGNED TO BE CALLED DIRECTLY!!!</p>
</div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</section>
<section>
</section>
Expand All @@ -52,31 +53,36 @@ <h2 class="section-title" id="header-functions">Functions</h2>
</code></dt>
<dd>
<div class="desc"></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
<dt id="dsm.losses.conditional_loss"><code class="name flex">
<span>def <span class="ident">conditional_loss</span></span>(<span>model, x, t, e, elbo=True, risk='1')</span>
</code></dt>
<dd>
<div class="desc"></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
<dt id="dsm.losses.predict_mean"><code class="name flex">
<span>def <span class="ident">predict_mean</span></span>(<span>model, x, risk='1')</span>
</code></dt>
<dd>
<div class="desc"></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
<dt id="dsm.losses.predict_cdf"><code class="name flex">
<span>def <span class="ident">predict_cdf</span></span>(<span>model, x, t_horizon, risk='1')</span>
</code></dt>
<dd>
<div class="desc"></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<img src="https://ndownloader.figshare.com/files/26367844">
<h1>Index</h1>
<div class="toc">
<ul></ul>
Expand Down
5 changes: 5 additions & 0 deletions docs/utilities.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ <h1 class="title">Module <code>dsm.utilities</code></h1>
</header>
<section id="section-intro">
<p>Utility functions to train the Deep Survival Machines models</p>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</section>
<section>
</section>
Expand All @@ -41,25 +42,29 @@ <h2 class="section-title" id="header-functions">Functions</h2>
</code></dt>
<dd>
<div class="desc"></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
<dt id="dsm.utilities.pretrain_dsm"><code class="name flex">
<span>def <span class="ident">pretrain_dsm</span></span>(<span>model, t_train, e_train, t_valid, e_valid, n_iter=10000, lr=0.01, thres=0.0001)</span>
</code></dt>
<dd>
<div class="desc"></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
<dt id="dsm.utilities.train_dsm"><code class="name flex">
<span>def <span class="ident">train_dsm</span></span>(<span>model, x_train, t_train, e_train, x_valid, t_valid, e_valid, n_iter=10000, lr=0.001, elbo=True, bs=100)</span>
</code></dt>
<dd>
<div class="desc"><p>Function to train the torch instance of the model.</p></div>
<div class="git-link-div"><a href="https://github.com/autonlab/DeepSurvivalMachines" class="git-link">Browse git</a></div>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<img src="https://ndownloader.figshare.com/files/26367844">
<h1>Index</h1>
<div class="toc">
<ul></ul>
Expand Down

0 comments on commit a2b0d8e

Please sign in to comment.