Skip to content

Commit 6c5162e

Browse files
ardunnardunn
committed
update docs
1 parent c67be4f commit 6c5162e

19 files changed

+74
-44
lines changed

‎docs/_sources/guide.rst.txt

+5-2
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ For custom predictors, arguments are passed directly to the predictor function a
228228
229229
predictor_args=[5, 7.9, "some_positional_hyperparam_value"]
230230
231-
For more info, see the extras.py example.
231+
232232
233233
234234
:code:`predictor_kwargs`
@@ -252,7 +252,7 @@ For custom predictors, arguments are passed directly to the predictor function.
252252
predictor={"my_kwarg1": 12, "my_kwarg2": "brown"}
253253
254254
255-
For more info, see the extras.py example.
255+
For more info, see the batch.py example's custom predictor function where :code:`batch_size` is used as a custom predictor function kwarg.
256256

257257

258258

@@ -588,6 +588,9 @@ The :code:`batch_size` parameter determines the batch size; default 1.
588588
batch_size=20
589589
590590
591+
592+
Note if using a custom predictor, your custom predictor should return the same number of guesses as the :code:`batch_size`.
593+
591594
See batch.py example for a demonstration.
592595

593596

‎docs/_sources/index.rst.txt

+9
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,15 @@ exhaustively documents the possible arguments to ``MissionControl`` and provides
251251
one example of each. If working through the tutorial did not answer your
252252
question, you'll most likely find your answer here.
253253

254+
255+
`Examples <https://github.com/hackingmaterials/rocketsled/tree/main/rocketsled/examples>`_
256+
-------------------------------------------------------------------------------------------
257+
258+
If neither the comprehensive guide or tutorials answered your question, working through the `examples <https://github.com/hackingmaterials/rocketsled/tree/main/rocketsled/examples>`_ may help.
259+
260+
Find the examples in the source code directory under "examples".
261+
262+
254263
Contributions and Support
255264
-------------------------
256265
Want to see something added or changed? Here's a few ways you can!

‎docs/_static/documentation_options.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '1.0.1.20200523',
3+
VERSION: '1.1.0.20211129',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

‎docs/advanced.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Advanced Tutorial - 15-20 min &#8212; rocketsled 1.0.1.20200523 documentation</title>
8+
<title>Advanced Tutorial - 15-20 min &#8212; rocketsled 1.1.0.20211129 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/nature.css" />
1111
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -27,7 +27,7 @@ <h3>Navigation</h3>
2727
<li class="right" >
2828
<a href="py-modindex.html" title="Python Module Index"
2929
>modules</a> |</li>
30-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
30+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
3131
<li class="nav-item nav-item-this"><a href="">Advanced Tutorial - 15-20 min</a></li>
3232
</ul>
3333
</div>
@@ -248,7 +248,7 @@ <h3>Navigation</h3>
248248
<li class="right" >
249249
<a href="py-modindex.html" title="Python Module Index"
250250
>modules</a> |</li>
251-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
251+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
252252
<li class="nav-item nav-item-this"><a href="">Advanced Tutorial - 15-20 min</a></li>
253253
</ul>
254254
</div>

‎docs/basic.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Basic Tutorial - 5-10 min &#8212; rocketsled 1.0.1.20200523 documentation</title>
8+
<title>Basic Tutorial - 5-10 min &#8212; rocketsled 1.1.0.20211129 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/nature.css" />
1111
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -27,7 +27,7 @@ <h3>Navigation</h3>
2727
<li class="right" >
2828
<a href="py-modindex.html" title="Python Module Index"
2929
>modules</a> |</li>
30-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
30+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
3131
<li class="nav-item nav-item-this"><a href="">Basic Tutorial - 5-10 min</a></li>
3232
</ul>
3333
</div>
@@ -175,7 +175,7 @@ <h3>Navigation</h3>
175175
<li class="right" >
176176
<a href="py-modindex.html" title="Python Module Index"
177177
>modules</a> |</li>
178-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
178+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
179179
<li class="nav-item nav-item-this"><a href="">Basic Tutorial - 5-10 min</a></li>
180180
</ul>
181181
</div>

‎docs/genindex.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Index &#8212; rocketsled 1.0.1.20200523 documentation</title>
8+
<title>Index &#8212; rocketsled 1.1.0.20211129 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/nature.css" />
1111
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -27,7 +27,7 @@ <h3>Navigation</h3>
2727
<li class="right" >
2828
<a href="py-modindex.html" title="Python Module Index"
2929
>modules</a> |</li>
30-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
30+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
3131
<li class="nav-item nav-item-this"><a href="">Index</a></li>
3232
</ul>
3333
</div>
@@ -556,7 +556,7 @@ <h3>Navigation</h3>
556556
<li class="right" >
557557
<a href="py-modindex.html" title="Python Module Index"
558558
>modules</a> |</li>
559-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
559+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
560560
<li class="nav-item nav-item-this"><a href="">Index</a></li>
561561
</ul>
562562
</div>

‎docs/guide.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Comprehensive Guide &#8212; rocketsled 1.0.1.20200523 documentation</title>
8+
<title>Comprehensive Guide &#8212; rocketsled 1.1.0.20211129 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/nature.css" />
1111
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -27,7 +27,7 @@ <h3>Navigation</h3>
2727
<li class="right" >
2828
<a href="py-modindex.html" title="Python Module Index"
2929
>modules</a> |</li>
30-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
30+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
3131
<li class="nav-item nav-item-this"><a href="">Comprehensive Guide</a></li>
3232
</ul>
3333
</div>
@@ -207,7 +207,6 @@ <h3><code class="code docutils literal notranslate"><span class="pre">predictor_
207207
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">predictor_args</span><span class="o">=</span><span class="p">[</span><span class="mi">5</span><span class="p">,</span> <span class="mf">7.9</span><span class="p">,</span> <span class="s2">&quot;some_positional_hyperparam_value&quot;</span><span class="p">]</span>
208208
</pre></div>
209209
</div>
210-
<p>For more info, see the extras.py example.</p>
211210
</div>
212211
<div class="section" id="predictor-kwargs">
213212
<h3><code class="code docutils literal notranslate"><span class="pre">predictor_kwargs</span></code><a class="headerlink" href="#predictor-kwargs" title="Permalink to this headline"></a></h3>
@@ -222,7 +221,7 @@ <h3><code class="code docutils literal notranslate"><span class="pre">predictor_
222221
<span class="n">predictor</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;my_kwarg1&quot;</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span> <span class="s2">&quot;my_kwarg2&quot;</span><span class="p">:</span> <span class="s2">&quot;brown&quot;</span><span class="p">}</span>
223222
</pre></div>
224223
</div>
225-
<p>For more info, see the extras.py example.</p>
224+
<p>For more info, see the batch.py example’s custom predictor function where <code class="code docutils literal notranslate"><span class="pre">batch_size</span></code> is used as a custom predictor function kwarg.</p>
226225
</div>
227226
</div>
228227
<div class="section" id="workflow-creator-function">
@@ -452,6 +451,7 @@ <h3><code class="code docutils literal notranslate"><span class="pre">batch_size
452451
<span class="n">batch_size</span><span class="o">=</span><span class="mi">20</span>
453452
</pre></div>
454453
</div>
454+
<p>Note if using a custom predictor, your custom predictor should return the same number of guesses as the <code class="code docutils literal notranslate"><span class="pre">batch_size</span></code>.</p>
455455
<p>See batch.py example for a demonstration.</p>
456456
<p><em>Note: Enabling large batch sizes may cause synchronicity issues. For example, rocketsled waits for all batch calcs to finish before running
457457
another batch. If one calc fails, the batch optimization will fail.</em></p>
@@ -584,7 +584,7 @@ <h3>Navigation</h3>
584584
<li class="right" >
585585
<a href="py-modindex.html" title="Python Module Index"
586586
>modules</a> |</li>
587-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
587+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
588588
<li class="nav-item nav-item-this"><a href="">Comprehensive Guide</a></li>
589589
</ul>
590590
</div>

‎docs/index.html

+9-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>rocketsled &#8212; rocketsled 1.0.1.20200523 documentation</title>
8+
<title>rocketsled &#8212; rocketsled 1.1.0.20211129 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/nature.css" />
1111
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -27,7 +27,7 @@ <h3>Navigation</h3>
2727
<li class="right" >
2828
<a href="py-modindex.html" title="Python Module Index"
2929
>modules</a> |</li>
30-
<li class="nav-item nav-item-0"><a href="#">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
30+
<li class="nav-item nav-item-0"><a href="#">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
3131
<li class="nav-item nav-item-this"><a href="">rocketsled</a></li>
3232
</ul>
3333
</div>
@@ -204,6 +204,11 @@ <h2><a class="reference internal" href="guide.html"><span class="doc">A Comprehe
204204
one example of each. If working through the tutorial did not answer your
205205
question, you’ll most likely find your answer here.</p>
206206
</div>
207+
<div class="section" id="id2">
208+
<h2><a class="reference external" href="https://github.com/hackingmaterials/rocketsled/tree/main/rocketsled/examples">Examples</a><a class="headerlink" href="#id2" title="Permalink to this headline"></a></h2>
209+
<p>If neither the comprehensive guide or tutorials answered your question, working through the <a class="reference external" href="https://github.com/hackingmaterials/rocketsled/tree/main/rocketsled/examples">examples</a> may help.</p>
210+
<p>Find the examples in the source code directory under “examples”.</p>
211+
</div>
207212
<div class="section" id="contributions-and-support">
208213
<h2>Contributions and Support<a class="headerlink" href="#contributions-and-support" title="Permalink to this headline"></a></h2>
209214
<p>Want to see something added or changed? Here’s a few ways you can!</p>
@@ -291,6 +296,7 @@ <h3><a href="#">Table of Contents</a></h3>
291296
<li><a class="reference internal" href="#get-started">Get Started</a><ul>
292297
<li><a class="reference internal" href="#tutorial"><span class="xref std std-doc">Tutorial</span></a></li>
293298
<li><a class="reference internal" href="#a-comprehensive-guide-to-rocketsled"><span class="xref std std-doc">A Comprehensive Guide to rocketsled</span></a></li>
299+
<li><a class="reference internal" href="#id2">Examples</a></li>
294300
<li><a class="reference internal" href="#contributions-and-support">Contributions and Support</a></li>
295301
<li><a class="reference internal" href="#citing-rocketsled">Citing rocketsled</a></li>
296302
<li><a class="reference internal" href="#documentation">Documentation</a></li>
@@ -328,7 +334,7 @@ <h3>Navigation</h3>
328334
<li class="right" >
329335
<a href="py-modindex.html" title="Python Module Index"
330336
>modules</a> |</li>
331-
<li class="nav-item nav-item-0"><a href="#">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
337+
<li class="nav-item nav-item-0"><a href="#">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
332338
<li class="nav-item nav-item-this"><a href="">rocketsled</a></li>
333339
</ul>
334340
</div>

‎docs/modules.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>rocketsled &#8212; rocketsled 1.0.1.20200523 documentation</title>
8+
<title>rocketsled &#8212; rocketsled 1.1.0.20211129 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/nature.css" />
1111
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -27,7 +27,7 @@ <h3>Navigation</h3>
2727
<li class="right" >
2828
<a href="py-modindex.html" title="Python Module Index"
2929
>modules</a> |</li>
30-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
30+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
3131
<li class="nav-item nav-item-this"><a href="">rocketsled</a></li>
3232
</ul>
3333
</div>
@@ -110,7 +110,7 @@ <h3>Navigation</h3>
110110
<li class="right" >
111111
<a href="py-modindex.html" title="Python Module Index"
112112
>modules</a> |</li>
113-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
113+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
114114
<li class="nav-item nav-item-this"><a href="">rocketsled</a></li>
115115
</ul>
116116
</div>

‎docs/objects.inv

0 Bytes
Binary file not shown.

‎docs/py-modindex.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Python Module Index &#8212; rocketsled 1.0.1.20200523 documentation</title>
8+
<title>Python Module Index &#8212; rocketsled 1.1.0.20211129 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/nature.css" />
1111
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -30,7 +30,7 @@ <h3>Navigation</h3>
3030
<li class="right" >
3131
<a href="#" title="Python Module Index"
3232
>modules</a> |</li>
33-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
33+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
3434
<li class="nav-item nav-item-this"><a href="">Python Module Index</a></li>
3535
</ul>
3636
</div>
@@ -149,7 +149,7 @@ <h3>Navigation</h3>
149149
<li class="right" >
150150
<a href="#" title="Python Module Index"
151151
>modules</a> |</li>
152-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
152+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
153153
<li class="nav-item nav-item-this"><a href="">Python Module Index</a></li>
154154
</ul>
155155
</div>

‎docs/rocketsled.examples.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>rocketsled.examples package &#8212; rocketsled 1.0.1.20200523 documentation</title>
8+
<title>rocketsled.examples package &#8212; rocketsled 1.1.0.20211129 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/nature.css" />
1111
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -27,7 +27,7 @@ <h3>Navigation</h3>
2727
<li class="right" >
2828
<a href="py-modindex.html" title="Python Module Index"
2929
>modules</a> |</li>
30-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
30+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
3131
<li class="nav-item nav-item-this"><a href="">rocketsled.examples package</a></li>
3232
</ul>
3333
</div>
@@ -379,7 +379,7 @@ <h3>Navigation</h3>
379379
<li class="right" >
380380
<a href="py-modindex.html" title="Python Module Index"
381381
>modules</a> |</li>
382-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
382+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
383383
<li class="nav-item nav-item-this"><a href="">rocketsled.examples package</a></li>
384384
</ul>
385385
</div>

‎docs/rocketsled.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>rocketsled package &#8212; rocketsled 1.0.1.20200523 documentation</title>
8+
<title>rocketsled package &#8212; rocketsled 1.1.0.20211129 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/nature.css" />
1111
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -27,7 +27,7 @@ <h3>Navigation</h3>
2727
<li class="right" >
2828
<a href="py-modindex.html" title="Python Module Index"
2929
>modules</a> |</li>
30-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
30+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
3131
<li class="nav-item nav-item-this"><a href="">rocketsled package</a></li>
3232
</ul>
3333
</div>
@@ -886,7 +886,7 @@ <h3>Navigation</h3>
886886
<li class="right" >
887887
<a href="py-modindex.html" title="Python Module Index"
888888
>modules</a> |</li>
889-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.0.1.20200523 documentation</a> &#187;</li>
889+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 1.1.0.20211129 documentation</a> &#187;</li>
890890
<li class="nav-item nav-item-this"><a href="">rocketsled package</a></li>
891891
</ul>
892892
</div>

0 commit comments

Comments
 (0)