Add changes for c97d8cf

janelia-cellmap · Feb 15, 2024 · 074b70e · 074b70e
1 parent 74142fd
commit 074b70e
Show file tree

Hide file tree

Showing 11 changed files with 438 additions and 12 deletions.
diff --git a/api/components.html b/api/components.html
@@ -185,7 +185,15 @@
   <ul class="md-nav__list" data-md-scrollfix="">
         <li class="md-nav__item"><a href="#api-components--page-root" class="md-nav__link">Components Reference</a><nav class="md-nav">
               <ul class="md-nav__list">
-        <li class="md-nav__item"><a href="#run" class="md-nav__link">Run</a>
+        <li class="md-nav__item"><a href="#run" class="md-nav__link">Run</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#dacapo.experiments.Run" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">Run</span></code></a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#dacapo.experiments.Run.get_validation_scores" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">Run.get_validation_scores()</span></code></a>
+        </li></ul>
+            </nav>
+        </li></ul>
+            </nav>
         </li>
         <li class="md-nav__item"><a href="#main-components" class="md-nav__link">Main Components</a>
         </li></ul>
@@ -209,6 +217,22 @@
 <span id="sec-components-api"></span><h1 id="api-components--page-root">Components Reference<a class="headerlink" href="#api-components--page-root" title="Link to this heading">¶</a></h1>
 <section id="run">
 <h2 id="run">Run<a class="headerlink" href="#run" title="Link to this heading">¶</a></h2>
+<blockquote>
+<div><dl class="py class">
+<dt class="sig sig-object py" id="dacapo.experiments.Run">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dacapo.experiments.</span></span><span class="sig-name descname"><span class="pre">Run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">run_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dacapo.experiments.Run" title="Link to this definition">¶</a></dt>
+<dd><dl class="py method">
+<dt class="sig sig-object py" id="dacapo.experiments.Run.get_validation_scores">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_validation_scores</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">run_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dacapo.experiments.Run.get_validation_scores" title="Link to this definition">¶</a></dt>
+<dd><p>Static method to avoid having to initialize model, optimizer, trainer, etc.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValidationScores</span></code></span></p>
+</dd>
+</dl>
+</dd></dl>
+</dd></dl>
+</div></blockquote>
 </section>
 <section id="main-components">
 <h2 id="main-components">Main Components<a class="headerlink" href="#main-components" title="Link to this heading">¶</a></h2>

diff --git a/api/components/task.html b/api/components/task.html
@@ -186,7 +186,17 @@
   <ul class="md-nav__list" data-md-scrollfix="">
         <li class="md-nav__item"><a href="#api-components-task--page-root" class="md-nav__link">Task Reference</a><nav class="md-nav">
               <ul class="md-nav__list">
-        <li class="md-nav__item"><a href="#task" class="md-nav__link">Task</a>
+        <li class="md-nav__item"><a href="#task" class="md-nav__link">Task</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#dacapo.experiments.tasks.Task" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">Task</span></code></a>
+        </li>
+        <li class="md-nav__item"><a href="#dacapo.experiments.tasks.OneHotTask" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">OneHotTask</span></code></a>
+        </li>
+        <li class="md-nav__item"><a href="#dacapo.experiments.tasks.AffinitiesTask" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">AffinitiesTask</span></code></a>
+        </li>
+        <li class="md-nav__item"><a href="#dacapo.experiments.tasks.DistanceTask" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DistanceTask</span></code></a>
+        </li></ul>
+            </nav>
         </li></ul>
             </nav>
         </li>
@@ -208,6 +218,24 @@
 <h1 id="api-components-task--page-root">Task Reference<a class="headerlink" href="#api-components-task--page-root" title="Link to this heading">¶</a></h1>
 <section id="task">
 <h2 id="task">Task<a class="headerlink" href="#task" title="Link to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="dacapo.experiments.tasks.Task">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dacapo.experiments.tasks.</span></span><span class="sig-name descname"><span class="pre">Task</span></span><a class="headerlink" href="#dacapo.experiments.tasks.Task" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py class">
+<dt class="sig sig-object py" id="dacapo.experiments.tasks.OneHotTask">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dacapo.experiments.tasks.</span></span><span class="sig-name descname"><span class="pre">OneHotTask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dacapo.experiments.tasks.OneHotTask" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py class">
+<dt class="sig sig-object py" id="dacapo.experiments.tasks.AffinitiesTask">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dacapo.experiments.tasks.</span></span><span class="sig-name descname"><span class="pre">AffinitiesTask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dacapo.experiments.tasks.AffinitiesTask" title="Link to this definition">¶</a></dt>
+<dd><p>This is a task for generating voxel affinities.</p>
+</dd></dl>
+<dl class="py class">
+<dt class="sig sig-object py" id="dacapo.experiments.tasks.DistanceTask">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dacapo.experiments.tasks.</span></span><span class="sig-name descname"><span class="pre">DistanceTask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dacapo.experiments.tasks.DistanceTask" title="Link to this definition">¶</a></dt>
+<dd><p>This is just a dummy task for testing.</p>
+</dd></dl>
 </section>
 </section>
 

diff --git a/api/components/trainer.html b/api/components/trainer.html
@@ -280,7 +280,7 @@ <h2 id="trainer">Trainer<a class="headerlink" href="#trainer" title="Link to thi
 <dd><p>Perform <code class="docutils literal notranslate"><span class="pre">num_iterations</span></code> training iterations.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterator</span></code>[TrainingIterationStats]</span></p>
+<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterator</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">TrainingIterationStats</span></code>]</span></p>
 </dd>
 </dl>
 </dd></dl>