modified: docs/dsm_api.html

modified: docs/index.html
autonlab · Feb 7, 2021 · e88c885 · e88c885
1 parent 95d1057
commit e88c885
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 4 deletions.
diff --git a/docs/dsm_api.html b/docs/dsm_api.html
@@ -85,7 +85,7 @@ <h2 id="example">Example</h2>
 <h3>Methods</h3>
 <dl>
 <dt id="dsm.dsm_api.DeepSurvivalMachines.fit"><code class="name flex">
-<span>def <span class="ident">fit</span></span>(<span>self, x, t, e, vsize=0.15, iters=1, learning_rate=0.001, batch_size=100, elbo=True, optimizer='Adam', random_state=100)</span>
+<span>def <span class="ident">fit</span></span>(<span>self, x, t, e, vsize=0.15, val_data=None, iters=1, learning_rate=0.001, batch_size=100, elbo=True, optimizer='Adam', random_state=100)</span>
 </code></dt>
 <dd>
 <p class="inheritance">
@@ -104,6 +104,8 @@ <h2 id="parameters">Parameters</h2>
 <span><span class="MathJax_Preview"> \delta = 1 </span><script type="math/tex"> \delta = 1 </script></span> means the event took place.</dd>
 <dt><strong><code>vsize</code></strong> :&ensp;<code>float</code></dt>
 <dd>Amount of data to set aside as the validation set.</dd>
+<dt><strong><code>val_data</code></strong> :&ensp;<code>tuple</code></dt>
+<dd>A tuple of the validation dataset. If passed vsize is ignored.</dd>
 <dt><strong><code>iters</code></strong> :&ensp;<code>int</code></dt>
 <dd>The maximum number of training iterations on the training dataset.</dd>
 <dt><strong><code>learning_rate</code></strong> :&ensp;<code>float</code></dt>
@@ -229,7 +231,7 @@ <h2 id="returns">Returns</h2>
 <h3>Methods</h3>
 <dl>
 <dt id="dsm.dsm_api.DeepRecurrentSurvivalMachines.fit"><code class="name flex">
-<span>def <span class="ident">fit</span></span>(<span>self, x, t, e, vsize=0.15, iters=1, learning_rate=0.001, batch_size=100, elbo=True, optimizer='Adam', random_state=100)</span>
+<span>def <span class="ident">fit</span></span>(<span>self, x, t, e, vsize=0.15, val_data=None, iters=1, learning_rate=0.001, batch_size=100, elbo=True, optimizer='Adam', random_state=100)</span>
 </code></dt>
 <dd>
 <p class="inheritance">
@@ -248,6 +250,8 @@ <h2 id="parameters">Parameters</h2>
 <span><span class="MathJax_Preview"> \delta = 1 </span><script type="math/tex"> \delta = 1 </script></span> means the event took place.</dd>
 <dt><strong><code>vsize</code></strong> :&ensp;<code>float</code></dt>
 <dd>Amount of data to set aside as the validation set.</dd>
+<dt><strong><code>val_data</code></strong> :&ensp;<code>tuple</code></dt>
+<dd>A tuple of the validation dataset. If passed vsize is ignored.</dd>
 <dt><strong><code>iters</code></strong> :&ensp;<code>int</code></dt>
 <dd>The maximum number of training iterations on the training dataset.</dd>
 <dt><strong><code>learning_rate</code></strong> :&ensp;<code>float</code></dt>
@@ -373,7 +377,7 @@ <h2 id="returns">Returns</h2>
 <h3>Methods</h3>
 <dl>
 <dt id="dsm.dsm_api.DeepConvolutionalSurvivalMachines.fit"><code class="name flex">
-<span>def <span class="ident">fit</span></span>(<span>self, x, t, e, vsize=0.15, iters=1, learning_rate=0.001, batch_size=100, elbo=True, optimizer='Adam', random_state=100)</span>
+<span>def <span class="ident">fit</span></span>(<span>self, x, t, e, vsize=0.15, val_data=None, iters=1, learning_rate=0.001, batch_size=100, elbo=True, optimizer='Adam', random_state=100)</span>
 </code></dt>
 <dd>
 <p class="inheritance">
@@ -392,6 +396,8 @@ <h2 id="parameters">Parameters</h2>
 <span><span class="MathJax_Preview"> \delta = 1 </span><script type="math/tex"> \delta = 1 </script></span> means the event took place.</dd>
 <dt><strong><code>vsize</code></strong> :&ensp;<code>float</code></dt>
 <dd>Amount of data to set aside as the validation set.</dd>
+<dt><strong><code>val_data</code></strong> :&ensp;<code>tuple</code></dt>
+<dd>A tuple of the validation dataset. If passed vsize is ignored.</dd>
 <dt><strong><code>iters</code></strong> :&ensp;<code>int</code></dt>
 <dd>The maximum number of training iterations on the training dataset.</dd>
 <dt><strong><code>learning_rate</code></strong> :&ensp;<code>float</code></dt>
@@ -517,7 +523,7 @@ <h2 id="returns">Returns</h2>
 <h3>Methods</h3>
 <dl>
 <dt id="dsm.dsm_api.DeepCNNRNNSurvivalMachines.fit"><code class="name flex">
-<span>def <span class="ident">fit</span></span>(<span>self, x, t, e, vsize=0.15, iters=1, learning_rate=0.001, batch_size=100, elbo=True, optimizer='Adam', random_state=100)</span>
+<span>def <span class="ident">fit</span></span>(<span>self, x, t, e, vsize=0.15, val_data=None, iters=1, learning_rate=0.001, batch_size=100, elbo=True, optimizer='Adam', random_state=100)</span>
 </code></dt>
 <dd>
 <p class="inheritance">
@@ -536,6 +542,8 @@ <h2 id="parameters">Parameters</h2>
 <span><span class="MathJax_Preview"> \delta = 1 </span><script type="math/tex"> \delta = 1 </script></span> means the event took place.</dd>
 <dt><strong><code>vsize</code></strong> :&ensp;<code>float</code></dt>
 <dd>Amount of data to set aside as the validation set.</dd>
+<dt><strong><code>val_data</code></strong> :&ensp;<code>tuple</code></dt>
+<dd>A tuple of the validation dataset. If passed vsize is ignored.</dd>
 <dt><strong><code>iters</code></strong> :&ensp;<code>int</code></dt>
 <dd>The maximum number of training iterations on the training dataset.</dd>
 <dt><strong><code>learning_rate</code></strong> :&ensp;<code>float</code></dt>

diff --git a/docs/index.html b/docs/index.html
@@ -182,6 +182,10 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
 <p>NOT DESIGNED TO BE CALLED DIRECTLY!!!</p>
 </div></div>
 </dd>
+<dt><code class="name"><a title="dsm.prognostics" href="prognostics/index.html">dsm.prognostics</a></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 <dt><code class="name"><a title="dsm.utilities" href="utilities.html">dsm.utilities</a></code></dt>
 <dd>
 <div class="desc"><p>Utility functions to train the Deep Survival Machines models</p></div>
@@ -218,6 +222,7 @@ <h1>Index</h1>
 <li><code><a title="dsm.dsm_api" href="dsm_api.html">dsm.dsm_api</a></code></li>
 <li><code><a title="dsm.dsm_torch" href="dsm_torch.html">dsm.dsm_torch</a></code></li>
 <li><code><a title="dsm.losses" href="losses.html">dsm.losses</a></code></li>
+<li><code><a title="dsm.prognostics" href="prognostics/index.html">dsm.prognostics</a></code></li>
 <li><code><a title="dsm.utilities" href="utilities.html">dsm.utilities</a></code></li>
 </ul>
 </li>