Skip to content

Commit 471ef62

Browse files
ardunnardunn
committed
docupdate
1 parent 5647020 commit 471ef62

File tree

5 files changed

+67
-22
lines changed

5 files changed

+67
-22
lines changed

‎docs/genindex.html

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ <h1 id="index">Index</h1>
4949
| <a href="#C"><strong>C</strong></a>
5050
| <a href="#D"><strong>D</strong></a>
5151
| <a href="#E"><strong>E</strong></a>
52+
| <a href="#F"><strong>F</strong></a>
5253
| <a href="#G"><strong>G</strong></a>
5354
| <a href="#I"><strong>I</strong></a>
5455
| <a href="#L"><strong>L</strong></a>
@@ -146,10 +147,20 @@ <h2 id="E">E</h2>
146147
</ul></td>
147148
</tr></table>
148149

150+
<h2 id="F">F</h2>
151+
<table style="width: 100%" class="indextable genindextable"><tr>
152+
<td style="width: 33%; vertical-align: top;"><ul>
153+
<li><a href="rocketsled.html#rocketsled.control.MissionControl.fetch_matrices">fetch_matrices() (rocketsled.control.MissionControl method)</a>
154+
</li>
155+
</ul></td>
156+
</tr></table>
157+
149158
<h2 id="G">G</h2>
150159
<table style="width: 100%" class="indextable genindextable"><tr>
151160
<td style="width: 33%; vertical-align: top;"><ul>
152161
<li><a href="rocketsled.html#rocketsled.utils.get_default_opttask_kwargs">get_default_opttask_kwargs() (in module rocketsled.utils)</a>
162+
</li>
163+
<li><a href="rocketsled.html#rocketsled.utils.get_len">get_len() (in module rocketsled.utils)</a>
153164
</li>
154165
</ul></td>
155166
<td style="width: 33%; vertical-align: top;"><ul>
@@ -211,10 +222,12 @@ <h2 id="O">O</h2>
211222
<td style="width: 33%; vertical-align: top;"><ul>
212223
<li><a href="rocketsled.tests.html#rocketsled.tests.deserialize_func.obj_func">obj_func() (in module rocketsled.tests.deserialize_func)</a>
213224
</li>
214-
<li><a href="rocketsled.examples.html#rocketsled.examples.basic.ObjectiveFuncTask">ObjectiveFuncTask (class in rocketsled.examples.basic)</a>
225+
<li><a href="rocketsled.html#rocketsled.utils.ObjectiveError">ObjectiveError</a>
215226
</li>
216227
</ul></td>
217228
<td style="width: 33%; vertical-align: top;"><ul>
229+
<li><a href="rocketsled.examples.html#rocketsled.examples.basic.ObjectiveFuncTask">ObjectiveFuncTask (class in rocketsled.examples.basic)</a>
230+
</li>
218231
<li><a href="rocketsled.html#rocketsled.task.OptTask.optimize">optimize() (rocketsled.task.OptTask method)</a>
219232
</li>
220233
<li><a href="rocketsled.html#rocketsled.task.OptTask">OptTask (class in rocketsled.task)</a>
@@ -300,14 +313,12 @@ <h2 id="S">S</h2>
300313
<li><a href="rocketsled.html#rocketsled.utils.serialize">serialize() (in module rocketsled.utils)</a>
301314
</li>
302315
<li><a href="rocketsled.tests.html#rocketsled.tests.test_task.TestWorkflows.setUp">setUp() (rocketsled.tests.test_task.TestWorkflows method)</a>
303-
</li>
304-
<li><a href="rocketsled.html#rocketsled.utils.split_xz">split_xz() (in module rocketsled.utils)</a>
305316
</li>
306317
</ul></td>
307318
<td style="width: 33%; vertical-align: top;"><ul>
308-
<li><a href="rocketsled.html#rocketsled.task.OptTask.stash">stash() (rocketsled.task.OptTask method)</a>
319+
<li><a href="rocketsled.html#rocketsled.utils.split_xz">split_xz() (in module rocketsled.utils)</a>
309320
</li>
310-
<li><a href="rocketsled.tests.html#rocketsled.tests.test_task.suite">suite() (in module rocketsled.tests.test_task)</a>
321+
<li><a href="rocketsled.html#rocketsled.task.OptTask.stash">stash() (rocketsled.task.OptTask method)</a>
311322
</li>
312323
<li><a href="rocketsled.html#rocketsled.control.MissionControl.summarize">summarize() (rocketsled.control.MissionControl method)</a>
313324
</li>
@@ -342,10 +353,12 @@ <h2 id="T">T</h2>
342353
<li><a href="rocketsled.tests.html#rocketsled.tests.test_utils.TestUtilities.test_Dtypes">test_Dtypes() (rocketsled.tests.test_utils.TestUtilities method)</a>
343354
</li>
344355
<li><a href="rocketsled.tests.html#rocketsled.tests.test_task.TestWorkflows.test_duplicates">test_duplicates() (rocketsled.tests.test_task.TestWorkflows method)</a>
356+
</li>
357+
<li><a href="rocketsled.tests.html#rocketsled.tests.test_utils.TestUtilities.test_get_default_opttask_kwargs">test_get_default_opttask_kwargs() (rocketsled.tests.test_utils.TestUtilities method)</a>
345358
</li>
346359
</ul></td>
347360
<td style="width: 33%; vertical-align: top;"><ul>
348-
<li><a href="rocketsled.tests.html#rocketsled.tests.test_utils.TestUtilities.test_get_default_opttask_kwargs">test_get_default_opttask_kwargs() (rocketsled.tests.test_utils.TestUtilities method)</a>
361+
<li><a href="rocketsled.tests.html#rocketsled.tests.test_utils.TestUtilities.test_get_len">test_get_len() (rocketsled.tests.test_utils.TestUtilities method)</a>
349362
</li>
350363
<li><a href="rocketsled.tests.html#rocketsled.tests.test_task.TestWorkflows.test_get_z">test_get_z() (rocketsled.tests.test_task.TestWorkflows method)</a>
351364
</li>

‎docs/objects.inv

20 Bytes
Binary file not shown.

‎docs/rocketsled.html

Lines changed: 42 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
227227
<dd><p>Set up the optimization config. Required before using OptTask, but only
228228
needs to be done once. To reconfigure, use MissionControl.reset and then
229229
use configure again.</p>
230+
<p>Defaults can be found in defaults.yaml.</p>
230231
<p>Args:</p>
231232
<dl class="docutils">
232233
<dt>wf_creator (function or str): The function object that creates the</dt>
@@ -300,9 +301,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
300301
custom predictor used, or GaussianProcessRegressor used.</dd>
301302
<dt>acq (str): The acquisition function to use. Can be ‘ei’ for expected</dt>
302303
<dd>improvement, ‘pi’ for probability of improvement, or ‘lcb’ for
303-
lower confidence bound. Defaults to None, which means no
304-
acquisition function is used, and the highest predicted point is
305-
picked (greedy algorithm). Only applies to builtin predictors.</dd>
304+
lower confidence bound, or None for greedy selection. Only works
305+
with builtin predictors.</dd>
306306
<dt>space_file (str): The fully specified path of a pickle file</dt>
307307
<dd>containing a list of all possible searchable vectors.
308308
For example ‘/Users/myuser/myfolder/myspace.p’. When loaded,
@@ -377,19 +377,32 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
377377
</dl>
378378
</dd></dl>
379379

380+
<dl class="method">
381+
<dt id="rocketsled.control.MissionControl.fetch_matrices">
382+
<code class="descname">fetch_matrices</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#rocketsled.control.MissionControl.fetch_matrices" title="Permalink to this definition"></a></dt>
383+
<dd><p>Return the X and Y matrices for this optimization.</p>
384+
<dl class="docutils">
385+
<dt>Returns:</dt>
386+
<dd><dl class="first last docutils">
387+
<dt>all_x, all_y ([list], [list]): The X (input) matrix has dimensions</dt>
388+
<dd>n_samples, n_dimensions. The Y (output) matrix has dimensions
389+
n_samples, n_objectives. Only completed entries are retrieved.</dd>
390+
</dl>
391+
</dd>
392+
</dl>
393+
</dd></dl>
394+
380395
<dl class="method">
381396
<dt id="rocketsled.control.MissionControl.plot">
382397
<code class="descname">plot</code><span class="sig-paren">(</span><em>show_best=True</em>, <em>show_mean=True</em>, <em>latexify=False</em>, <em>font_family='serif'</em>, <em>scale='linear'</em>, <em>summarize=True</em>, <em>print_pareto=False</em><span class="sig-paren">)</span><a class="headerlink" href="#rocketsled.control.MissionControl.plot" title="Permalink to this definition"></a></dt>
383398
<dd><p>Visualize the progress of an optimization.</p>
384399
<dl class="docutils">
385400
<dt>Args:</dt>
386-
<dd><p class="first">maximize (bool): Whether to plot optimizing for minimum or maximum.
387-
show_best (bool): Point out the best point on legend and on plot. If</p>
388-
<blockquote>
389-
<div>more than one best point (i.e., multiple equal maxima), show
401+
<dd><dl class="first docutils">
402+
<dt>show_best (bool): Point out the best point on legend and on plot. If</dt>
403+
<dd>more than one best point (i.e., multiple equal maxima), show
390404
them all. If multiobjective, shows best for each objective, and
391-
prints the best value and x for each objective.</div></blockquote>
392-
<dl class="docutils">
405+
prints the best value and x for each objective.</dd>
393406
<dt>show_mean (bool): Show the mean and standard deviation for the</dt>
394407
<dd>guesses as the computations are carried out.</dd>
395408
</dl>
@@ -618,6 +631,13 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
618631
<p>When rocketsled config doc is broken or not found.</p>
619632
</dd></dl>
620633

634+
<dl class="exception">
635+
<dt id="rocketsled.utils.ObjectiveError">
636+
<em class="property">exception </em><code class="descclassname">rocketsled.utils.</code><code class="descname">ObjectiveError</code><a class="headerlink" href="#rocketsled.utils.ObjectiveError" title="Permalink to this definition"></a></dt>
637+
<dd><p>Bases: <a class="reference internal" href="#rocketsled.utils.RSBaseException" title="rocketsled.utils.RSBaseException"><code class="xref py py-class docutils literal notranslate"><span class="pre">rocketsled.utils.RSBaseException</span></code></a></p>
638+
<p>Errors relating to objectives.</p>
639+
</dd></dl>
640+
621641
<dl class="exception">
622642
<dt id="rocketsled.utils.RSBaseException">
623643
<em class="property">exception </em><code class="descclassname">rocketsled.utils.</code><code class="descname">RSBaseException</code><a class="headerlink" href="#rocketsled.utils.RSBaseException" title="Permalink to this definition"></a></dt>
@@ -708,6 +728,18 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
708728
</dl>
709729
</dd></dl>
710730

731+
<dl class="function">
732+
<dt id="rocketsled.utils.get_len">
733+
<code class="descclassname">rocketsled.utils.</code><code class="descname">get_len</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#rocketsled.utils.get_len" title="Permalink to this definition"></a></dt>
734+
<dd><p>A utility function for getting the length of an object.</p>
735+
<dl class="docutils">
736+
<dt>Args:</dt>
737+
<dd>obj: An object, optionally iterable.</dd>
738+
<dt>Returns:</dt>
739+
<dd>The length of that object if it is a list or tuple, otherwise 1.</dd>
740+
</dl>
741+
</dd></dl>
742+
711743
<dl class="function">
712744
<dt id="rocketsled.utils.is_discrete">
713745
<code class="descclassname">rocketsled.utils.</code><code class="descname">is_discrete</code><span class="sig-paren">(</span><em>dims</em>, <em>criteria='all'</em><span class="sig-paren">)</span><a class="headerlink" href="#rocketsled.utils.is_discrete" title="Permalink to this definition"></a></dt>
@@ -821,7 +853,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
821853
</div>
822854
<div class="section" id="module-rocketsled">
823855
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-rocketsled" title="Permalink to this headline"></a></h2>
824-
<p>Rocketsled is an optimization suite “on rails” based on Scikit-learn and
856+
<p>Rocketsled is an optimization suite “on rails” based on Scikit-learn and
825857
FireWorks workflows.</p>
826858
</div>
827859
</div>

‎docs/rocketsled.tests.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -242,11 +242,6 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
242242
<code class="descclassname">rocketsled.tests.test_task.</code><code class="descname">get_z</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#rocketsled.tests.test_task.get_z" title="Permalink to this definition"></a></dt>
243243
<dd></dd></dl>
244244

245-
<dl class="function">
246-
<dt id="rocketsled.tests.test_task.suite">
247-
<code class="descclassname">rocketsled.tests.test_task.</code><code class="descname">suite</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#rocketsled.tests.test_task.suite" title="Permalink to this definition"></a></dt>
248-
<dd></dd></dl>
249-
250245
<dl class="function">
251246
<dt id="rocketsled.tests.test_task.wf_creator_accuracy">
252247
<code class="descclassname">rocketsled.tests.test_task.</code><code class="descname">wf_creator_accuracy</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#rocketsled.tests.test_task.wf_creator_accuracy" title="Permalink to this definition"></a></dt>
@@ -332,6 +327,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
332327
<code class="descname">test_get_default_opttask_kwargs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#rocketsled.tests.test_utils.TestUtilities.test_get_default_opttask_kwargs" title="Permalink to this definition"></a></dt>
333328
<dd></dd></dl>
334329

330+
<dl class="method">
331+
<dt id="rocketsled.tests.test_utils.TestUtilities.test_get_len">
332+
<code class="descname">test_get_len</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#rocketsled.tests.test_utils.TestUtilities.test_get_len" title="Permalink to this definition"></a></dt>
333+
<dd></dd></dl>
334+
335335
<dl class="method">
336336
<dt id="rocketsled.tests.test_utils.TestUtilities.test_is_discrete">
337337
<code class="descname">test_is_discrete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#rocketsled.tests.test_utils.TestUtilities.test_is_discrete" title="Permalink to this definition"></a></dt>

0 commit comments

Comments
 (0)