Skip to content

Commit dfd8baa

Browse files
committed
update docs
1 parent 2629f8c commit dfd8baa

27 files changed

+673
-649
lines changed

docs/_sources/index.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. title:: rocketsled
22

3-
.. image:: _static/rsfw.png
3+
.. image:: _static/logo-med.png
44
:width: 600 px
55
:alt: rocketsled logo
66
:align: center

docs/_static/basic.css

Lines changed: 74 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx stylesheet -- basic theme.
66
*
7-
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -231,6 +231,16 @@ a.headerlink {
231231
visibility: hidden;
232232
}
233233

234+
a.brackets:before,
235+
span.brackets > a:before{
236+
content: "[";
237+
}
238+
239+
a.brackets:after,
240+
span.brackets > a:after {
241+
content: "]";
242+
}
243+
234244
h1:hover > a.headerlink,
235245
h2:hover > a.headerlink,
236246
h3:hover > a.headerlink,
@@ -391,6 +401,16 @@ table.citation td {
391401
border-bottom: none;
392402
}
393403

404+
th > p:first-child,
405+
td > p:first-child {
406+
margin-top: 0px;
407+
}
408+
409+
th > p:last-child,
410+
td > p:last-child {
411+
margin-bottom: 0px;
412+
}
413+
394414
/* -- figures --------------------------------------------------------------- */
395415

396416
div.figure {
@@ -460,11 +480,57 @@ ol.upperroman {
460480
list-style: upper-roman;
461481
}
462482

483+
li > p:first-child {
484+
margin-top: 0px;
485+
}
486+
487+
li > p:last-child {
488+
margin-bottom: 0px;
489+
}
490+
491+
dl.footnote > dt,
492+
dl.citation > dt {
493+
float: left;
494+
}
495+
496+
dl.footnote > dd,
497+
dl.citation > dd {
498+
margin-bottom: 0em;
499+
}
500+
501+
dl.footnote > dd:after,
502+
dl.citation > dd:after {
503+
content: "";
504+
clear: both;
505+
}
506+
507+
dl.field-list {
508+
display: flex;
509+
flex-wrap: wrap;
510+
}
511+
512+
dl.field-list > dt {
513+
flex-basis: 20%;
514+
font-weight: bold;
515+
word-break: break-word;
516+
}
517+
518+
dl.field-list > dt:after {
519+
content: ":";
520+
}
521+
522+
dl.field-list > dd {
523+
flex-basis: 70%;
524+
padding-left: 1em;
525+
margin-left: 0em;
526+
margin-bottom: 0em;
527+
}
528+
463529
dl {
464530
margin-bottom: 15px;
465531
}
466532

467-
dd p {
533+
dd > p:first-child {
468534
margin-top: 0px;
469535
}
470536

@@ -537,6 +603,12 @@ dl.glossary dt {
537603
font-style: oblique;
538604
}
539605

606+
.classifier:before {
607+
font-style: normal;
608+
margin: 0.5em;
609+
content: ":";
610+
}
611+
540612
abbr, acronym {
541613
border-bottom: dotted 1px;
542614
cursor: help;

docs/_static/doctools.js

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx JavaScript utilities for all documentation.
66
*
7-
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -87,14 +87,13 @@ jQuery.fn.highlightText = function(text, className) {
8787
node.nextSibling));
8888
node.nodeValue = val.substr(0, pos);
8989
if (isInSVG) {
90-
var bbox = span.getBBox();
9190
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
92-
rect.x.baseVal.value = bbox.x;
91+
var bbox = node.parentElement.getBBox();
92+
rect.x.baseVal.value = bbox.x;
9393
rect.y.baseVal.value = bbox.y;
9494
rect.width.baseVal.value = bbox.width;
9595
rect.height.baseVal.value = bbox.height;
9696
rect.setAttribute('class', className);
97-
var parentOfText = node.parentNode.parentNode;
9897
addItems.push({
9998
"parent": node.parentNode,
10099
"target": rect});

docs/_static/documentation_options.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '2019.3.15',
3+
VERSION: '2019.4.17',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
FILE_SUFFIX: '.html',
77
HAS_SOURCE: true,
88
SOURCELINK_SUFFIX: '.txt',
9-
NAVIGATION_WITH_KEYS: false,
9+
NAVIGATION_WITH_KEYS: false
1010
};

docs/_static/language_data.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* This script contains the language-specific data used by searchtools.js,
66
* namely the list of stopwords, stemmer, scorer and splitter.
77
*
8-
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
8+
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
99
* :license: BSD, see LICENSE for details.
1010
*
1111
*/

docs/_static/logo-small.png

136 KB
Loading

docs/_static/rsfw.png

-27.3 KB
Binary file not shown.

docs/_static/searchtools.js

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx JavaScript utilities for the full-text search.
66
*
7-
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -36,8 +36,10 @@ if (!Scorer) {
3636

3737
// query found in title
3838
title: 15,
39+
partialTitle: 7,
3940
// query found in terms
40-
term: 5
41+
term: 5,
42+
partialTerm: 2
4143
};
4244
}
4345

@@ -56,6 +58,14 @@ var Search = {
5658
_queued_query : null,
5759
_pulse_status : -1,
5860

61+
htmlToText : function(htmlString) {
62+
var htmlElement = document.createElement('span');
63+
htmlElement.innerHTML = htmlString;
64+
$(htmlElement).find('.headerlink').remove();
65+
docContent = $(htmlElement).find('[role=main]')[0];
66+
return docContent.textContent || docContent.innerText;
67+
},
68+
5969
init : function() {
6070
var params = $.getQueryParameters();
6171
if (params.q) {
@@ -120,7 +130,7 @@ var Search = {
120130
this.out = $('#search-results');
121131
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
122132
this.dots = $('<span></span>').appendTo(this.title);
123-
this.status = $('<p style="display: none"></p>').appendTo(this.out);
133+
this.status = $('<p class="search-summary">&nbsp;</p>').appendTo(this.out);
124134
this.output = $('<ul class="search"/>').appendTo(this.out);
125135

126136
$('#search-progress').text(_('Preparing search...'));
@@ -259,11 +269,7 @@ var Search = {
259269
displayNextItem();
260270
});
261271
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
262-
var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
263-
if (suffix === undefined) {
264-
suffix = '.txt';
265-
}
266-
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
272+
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX,
267273
dataType: "text",
268274
complete: function(jqxhr, textstatus) {
269275
var data = jqxhr.responseText;
@@ -385,6 +391,19 @@ var Search = {
385391
{files: terms[word], score: Scorer.term},
386392
{files: titleterms[word], score: Scorer.title}
387393
];
394+
// add support for partial matches
395+
if (word.length > 2) {
396+
for (var w in terms) {
397+
if (w.match(word) && !terms[word]) {
398+
_o.push({files: terms[w], score: Scorer.partialTerm})
399+
}
400+
}
401+
for (var w in titleterms) {
402+
if (w.match(word) && !titleterms[word]) {
403+
_o.push({files: titleterms[w], score: Scorer.partialTitle})
404+
}
405+
}
406+
}
388407

389408
// no match but word was a required one
390409
if ($u.every(_o, function(o){return o.files === undefined;})) {
@@ -424,8 +443,12 @@ var Search = {
424443
var valid = true;
425444

426445
// check if all requirements are matched
427-
if (fileMap[file].length != searchterms.length)
428-
continue;
446+
var filteredTermCount = // as search terms with length < 3 are discarded: ignore
447+
searchterms.filter(function(term){return term.length > 2}).length
448+
if (
449+
fileMap[file].length != searchterms.length &&
450+
fileMap[file].length != filteredTermCount
451+
) continue;
429452

430453
// ensure that none of the excluded terms is in the search result
431454
for (i = 0; i < excluded.length; i++) {
@@ -456,7 +479,8 @@ var Search = {
456479
* words. the first one is used to find the occurrence, the
457480
* latter for highlighting it.
458481
*/
459-
makeSearchSummary : function(text, keywords, hlwords) {
482+
makeSearchSummary : function(htmlText, keywords, hlwords) {
483+
var text = Search.htmlToText(htmlText);
460484
var textLower = text.toLowerCase();
461485
var start = 0;
462486
$.each(keywords, function() {

docs/advanced.html

Lines changed: 23 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11

2-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<!DOCTYPE html>
43

54
<html xmlns="http://www.w3.org/1999/xhtml">
65
<head>
7-
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
8-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>Advanced Tutorial - 15-20 min &#8212; rocketsled 2019.3.15 documentation</title>
6+
<meta charset="utf-8" />
7+
<title>Advanced Tutorial - 15-20 min &#8212; rocketsled 2019.4.17 documentation</title>
108
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
119
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1210
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -29,7 +27,7 @@ <h3>Navigation</h3>
2927
<li class="right" >
3028
<a href="py-modindex.html" title="Python Module Index"
3129
>modules</a> |</li>
32-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2019.3.15 documentation</a> &#187;</li>
30+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2019.4.17 documentation</a> &#187;</li>
3331
</ul>
3432
</div>
3533

@@ -51,32 +49,31 @@ <h1>Advanced Tutorial - 15-20 min<a class="headerlink" href="#advanced-tutorial-
5149
<p>OptTask has optional arguments which address each of these issues. A few are listed here, and the rest are in the comprehensive guide. For the most part, they are designed to work both in combination and independently.</p>
5250
<p>In this tutorial, we will explore some of the more advanced capabilities of OptTask, including:</p>
5351
<ul class="simple">
54-
<li>Multiobjective optimiation</li>
55-
<li><dl class="first docutils">
56-
<dt>Changing predictors</dt>
57-
<dd><ul class="first last">
58-
<li>Acquisition functions for improving performance</li>
59-
<li>Reducing prediction time</li>
60-
<li>Customizing exploration</li>
52+
<li><p>Multiobjective optimiation</p></li>
53+
<li><dl class="simple">
54+
<dt>Changing predictors</dt><dd><ul>
55+
<li><p>Acquisition functions for improving performance</p></li>
56+
<li><p>Reducing prediction time</p></li>
57+
<li><p>Customizing exploration</p></li>
6158
</ul>
6259
</dd>
6360
</dl>
6461
</li>
65-
<li>Using z (extra) features</li>
62+
<li><p>Using z (extra) features</p></li>
6663
</ul>
6764
<div class="section" id="defining-the-problem">
6865
<h2>Defining the Problem<a class="headerlink" href="#defining-the-problem" title="Permalink to this headline"></a></h2>
6966
<p>Let’s imagine we are designing a fin for a new rocket. <strong>We have three parameters we can tune</strong>:</p>
7067
<ul class="simple">
71-
<li>Fin length - Defined between 16cm - 145cm</li>
72-
<li>Fin angle - Defined between 0.0 - 90.0 degrees</li>
73-
<li>Fin type - Either industry standard, dolphin, or shark type.</li>
68+
<li><p>Fin length - Defined between 16cm - 145cm</p></li>
69+
<li><p>Fin angle - Defined between 0.0 - 90.0 degrees</p></li>
70+
<li><p>Fin type - Either industry standard, dolphin, or shark type.</p></li>
7471
</ul>
7572
<p><strong>We’ll say a good fin has 3 characteristics (objective metrics)</strong>:</p>
7673
<ul class="simple">
77-
<li>Low cost</li>
78-
<li>Low drag</li>
79-
<li>Low probability of failure</li>
74+
<li><p>Low cost</p></li>
75+
<li><p>Low drag</p></li>
76+
<li><p>Low probability of failure</p></li>
8077
</ul>
8178
<p>We evaluate the performance of a candidate design by nondeterministically simulating the aerodynamics and market performance with an expensive simulation.
8279
A mock version of such a simulation is found in <code class="code docutils literal notranslate"><span class="pre">ComplexMultiObjTask</span></code> in <code class="code docutils literal notranslate"><span class="pre">/examples/tasks.py</span></code>.</p>
@@ -120,10 +117,10 @@ <h2>Creating the Workflow<a class="headerlink" href="#creating-the-workflow" tit
120117
</div>
121118
<p>The new arguments to OptTask are:</p>
122119
<ul class="simple">
123-
<li><code class="code docutils literal notranslate"><span class="pre">predictor</span></code> - A different built in predictor is used for this optimization. A full list of builtin predictors (and guide for using custom predictors) is shown in the comprehensive guide.</li>
124-
<li><code class="code docutils literal notranslate"><span class="pre">acq</span></code> - Acquisition functions help us get better results during optimization (generally) than pure exploitation, but may be more computationally intensive. The acquisition function used here is specifically for multi-objective optimization; for single objectives, check the comprehensive guide.</li>
125-
<li><code class="code docutils literal notranslate"><span class="pre">n_searchpts</span></code> - Tuning the number of points for prediction affects optimizer performance and computational efficiency (the two are often inversely correlated). Also use <code class="code docutils literal notranslate"><span class="pre">n_trainpts</span></code> to restrict the number of points used for training from completed runs.</li>
126-
<li><code class="code docutils literal notranslate"><span class="pre">get_z</span></code> - Encapsulate empirical knowledge with get_z. From physical laws, we postulate two useful features, which we put in a vector called “z”. When <code class="code docutils literal notranslate"><span class="pre">get_z</span></code> is enabled, x is only used as a label (<strong>not for learning</strong>), unless explicitly returned by get_z. In this case, x might be useful for learning, so we’ll return it.</li>
120+
<li><p><code class="code docutils literal notranslate"><span class="pre">predictor</span></code> - A different built in predictor is used for this optimization. A full list of builtin predictors (and guide for using custom predictors) is shown in the comprehensive guide.</p></li>
121+
<li><p><code class="code docutils literal notranslate"><span class="pre">acq</span></code> - Acquisition functions help us get better results during optimization (generally) than pure exploitation, but may be more computationally intensive. The acquisition function used here is specifically for multi-objective optimization; for single objectives, check the comprehensive guide.</p></li>
122+
<li><p><code class="code docutils literal notranslate"><span class="pre">n_searchpts</span></code> - Tuning the number of points for prediction affects optimizer performance and computational efficiency (the two are often inversely correlated). Also use <code class="code docutils literal notranslate"><span class="pre">n_trainpts</span></code> to restrict the number of points used for training from completed runs.</p></li>
123+
<li><p><code class="code docutils literal notranslate"><span class="pre">get_z</span></code> - Encapsulate empirical knowledge with get_z. From physical laws, we postulate two useful features, which we put in a vector called “z”. When <code class="code docutils literal notranslate"><span class="pre">get_z</span></code> is enabled, x is only used as a label (<strong>not for learning</strong>), unless explicitly returned by get_z. In this case, x might be useful for learning, so we’ll return it.</p></li>
127124
</ul>
128125
<p>We can launch 250 optimization loop runs with:</p>
129126
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">run_workflows</span><span class="p">():</span>
@@ -232,8 +229,6 @@ <h3>Quick search</h3>
232229
<form class="search" action="search.html" method="get">
233230
<input type="text" name="q" />
234231
<input type="submit" value="Go" />
235-
<input type="hidden" name="check_keywords" value="yes" />
236-
<input type="hidden" name="area" value="default" />
237232
</form>
238233
</div>
239234
</div>
@@ -251,13 +246,13 @@ <h3>Navigation</h3>
251246
<li class="right" >
252247
<a href="py-modindex.html" title="Python Module Index"
253248
>modules</a> |</li>
254-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2019.3.15 documentation</a> &#187;</li>
249+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2019.4.17 documentation</a> &#187;</li>
255250
</ul>
256251
</div>
257252

258253
<div class="footer" role="contentinfo">
259254
&#169; Copyright 2018, HackingMaterials.
260-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
255+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.0.1.
261256
</div>
262257

263258
</body>

0 commit comments

Comments
 (0)