-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathuser_guide.html
501 lines (449 loc) · 21.1 KB
/
user_guide.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="Description" content="scikit-optimize: machine learning in Python">
<title>User guide: contents — scikit-optimize 0.8.1 documentation</title>
<link rel="canonical" href="https://scikit-optimize.github.io/user_guide.html" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="stylesheet" href="_static/css/vendor/bootstrap.min.css" type="text/css" />
<link rel="stylesheet" href="_static/gallery.css" type="text/css" />
<link rel="stylesheet" href="_static/gallery-binder.css" type="text/css" />
<link rel="stylesheet" href="_static/gallery-dataframe.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
</head>
<body>
<nav id="navbar" class="sk-docs-navbar navbar navbar-expand-md navbar-light bg-light py-0">
<div class="container-fluid sk-docs-container px-0">
<a class="navbar-brand py-0" href="index.html">
<img
class="sk-brand-img"
src="_static/logo.png"
alt="logo"/>
</a>
<button
id="sk-navbar-toggler"
class="navbar-toggler"
type="button"
data-toggle="collapse"
data-target="#navbarSupportedContent"
aria-controls="navbarSupportedContent"
aria-expanded="false"
aria-label="Toggle navigation"
>
<span class="navbar-toggler-icon"></span>
</button>
<div class="sk-navbar-collapse collapse navbar-collapse" id="navbarSupportedContent">
<ul class="navbar-nav mr-auto">
<li class="nav-item">
<a class="sk-nav-link nav-link" href="install.html">Install</a>
</li>
<li class="nav-item">
<a class="sk-nav-link nav-link" href="#">User Guide</a>
</li>
<li class="nav-item">
<a class="sk-nav-link nav-link" href="modules/classes.html">API</a>
</li>
<li class="nav-item">
<a class="sk-nav-link nav-link" href="auto_examples/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="sk-nav-link nav-link nav-more-item-mobile-items" href="getting_started.html">Getting Started</a>
</li>
<li class="nav-item">
<a class="sk-nav-link nav-link nav-more-item-mobile-items" href="development.html">Development</a>
</li>
<li class="nav-item">
<a class="sk-nav-link nav-link nav-more-item-mobile-items" href="https://github.com/scikit-optimize/scikit-optimize">GitHub</a>
</li>
<li class="nav-item">
<a class="sk-nav-link nav-link nav-more-item-mobile-items" href="https://scikit-optimize.github.io/dev/versions.html">Other Versions</a>
</li>
<li class="nav-item dropdown nav-more-item-dropdown">
<a class="sk-nav-link nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">More</a>
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
<a class="sk-nav-dropdown-item dropdown-item" href="getting_started.html">Getting Started</a>
<a class="sk-nav-dropdown-item dropdown-item" href="development.html">Development</a>
<a class="sk-nav-dropdown-item dropdown-item" href="https://github.com/scikit-optimize/scikit-optimize">GitHub</a>
<a class="sk-nav-dropdown-item dropdown-item" href="https://scikit-optimize.github.io/dev/versions.html">Other Versions</a>
</div>
</li>
</ul>
<div id="searchbox" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input class="sk-search-text-input" type="text" name="q" aria-labelledby="searchlabel" />
<input class="sk-search-text-btn" type="submit" value="Go" />
</form>
</div>
</div>
</div>
</div>
</nav>
<div class="d-flex" id="sk-doc-wrapper">
<input type="checkbox" name="sk-toggle-checkbox" id="sk-toggle-checkbox">
<label id="sk-sidemenu-toggle" class="sk-btn-toggle-toc btn sk-btn-primary" for="sk-toggle-checkbox">Toggle Menu</label>
<div id="sk-sidebar-wrapper" class="border-right">
<div class="sk-sidebar-toc-wrapper">
<div class="sk-sidebar-toc-logo">
<a href="index.html">
<img
class="sk-brand-img"
src="_static/logo.png"
alt="logo"/>
</a>
</div>
<div class="btn-group w-100 mb-2" role="group" aria-label="rellinks">
<a href="getting_started.html" role="button" class="btn sk-btn-rellink py-1" sk-rellink-tooltip="Getting started">Prev</a>
<a href="#" role="button" class="btn sk-btn-rellink disabled py-1">Up</a>
<a href="modules/acquisition.html" role="button" class="btn sk-btn-rellink py-1" sk-rellink-tooltip="1. Acquisition">Next</a>
</div>
<div class="alert alert-danger p-1 mb-2" role="alert">
<p class="text-center mb-0">
<strong>scikit-optimize 0.8.1</strong><br/>
<a href="https://scikit-optimize.github.io/dev/versions.html">Other versions</a>
</p>
</div>
<div class="sk-sidebar-toc sk-sidebar-global-toc">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="preface.html">Welcome to scikit-optimize</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">User Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/acquisition.html">1. Acquisition</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/bayessearchcv.html">2. BayesSearchCV, a GridSearchCV compatible estimator</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/callbacks.html">3. Callbacks</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/optimizer.html">4. Optimizer, an ask-and-tell interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/minimize_functions.html">5. <code class="docutils literal notranslate"><span class="pre">skopt</span></code>’s top level minimization functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/plots.html">6. Plotting tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/space.html">7. Space</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html">8. Utility functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules/classes.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
</ul>
</div>
</div>
</div>
<div id="sk-page-content-wrapper">
<div class="sk-page-content container-fluid body px-md-3" role="main">
<div class="section" id="user-guide">
<span id="id1"></span><h1>User Guide<a class="headerlink" href="#user-guide" title="Permalink to this headline">¶</a></h1>
<style type="text/css">
div.body div.toctree-wrapper ul {
padding-left: 0;
}
div.body li.toctree-l1 {
padding: 0 0 0.5em 0;
list-style-type: none;
font-size: 150%;
font-weight: bold;
}
div.body li.toctree-l2 {
font-size: 70%;
list-style-type: square;
font-weight: normal;
margin-left: 40px;
}
div.body li.toctree-l3 {
font-size: 85%;
list-style-type: circle;
font-weight: normal;
margin-left: 40px;
}
div.body li.toctree-l4 {
margin-left: 40px;
}
</style> <script>
window.addEventListener('DOMContentLoaded', function() {
(function($) {
//Function to make the index toctree collapsible
$(function () {
$('div.body .toctree-l2')
.click(function(event){
if (event.target.tagName.toLowerCase() != "a") {
if ($(this).children('ul').length > 0) {
$(this).attr('data-content',
(!$(this).children('ul').is(':hidden')) ? '\u25ba' : '\u25bc');
$(this).children('ul').toggle();
}
return true; //Makes links clickable
}
})
.mousedown(function(event){ return false; }) //Firefox highlighting fix
.children('ul').hide();
// Initialize the values
$('div.body li.toctree-l2:not(:has(ul))').attr('data-content', '-');
$('div.body li.toctree-l2:has(ul)').attr('data-content', '\u25ba');
$('div.body li.toctree-l2:has(ul)').css('cursor', 'pointer');
$('div.body .toctree-l2').hover(
function () {
if ($(this).children('ul').length > 0) {
$(this).css('background-color', '#e5e5e5').children('ul').css('background-color', '#F0F0F0');
$(this).attr('data-content',
(!$(this).children('ul').is(':hidden')) ? '\u25bc' : '\u25ba');
}
else {
$(this).css('background-color', '#F9F9F9');
}
},
function () {
$(this).css('background-color', 'white').children('ul').css('background-color', 'white');
if ($(this).children('ul').length > 0) {
$(this).attr('data-content',
(!$(this).children('ul').is(':hidden')) ? '\u25bc' : '\u25ba');
}
}
);
});
})(jQuery);
});
</script>
<style type="text/css">
div.body li, div.body ul {
transition-duration: 0.2s;
}
div.body li.toctree-l1 {
padding: 5px 0 0;
list-style-type: none;
font-size: 150%;
background-color: #f2f2f2;
font-weight: normal;
color: #20435c;
margin-left: 0;
margin-bottom: 1.2em;
font-weight: bold;
}
div.body li.toctree-l1 a {
color: #314F64;
}
div.body li.toctree-l1 > a {
margin-left: 0.75rem;
}
div.body li.toctree-l2 {
padding: 0.25em 0 0.25em 0 ;
list-style-type: none;
background-color: #FFFFFF;
font-size: 85% ;
font-weight: normal;
margin-left: 0;
}
div.body li.toctree-l2 ul {
padding-left: 40px ;
}
div.body li.toctree-l2:before {
content: attr(data-content);
font-size: 1rem;
color: #777;
display: inline-block;
width: 1.5rem;
}
div.body li.toctree-l3 {
font-size: 88% ;
list-style-type: square;
font-weight: normal;
margin-left: 0;
}
div.body li.toctree-l4 {
font-size: 93% ;
list-style-type: circle;
font-weight: normal;
margin-left: 0;
}
div.body div.topic li.toctree-l1 {
font-size: 100% ;
font-weight: bold;
background-color: transparent;
margin-bottom: 0;
margin-left: 1.5em;
display:inline;
}
div.body div.topic p {
font-size: 90% ;
margin: 0.4ex;
}
div.body div.topic p.topic-title {
display:inline;
font-size: 100% ;
margin-bottom: 0;
}
</style><div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules/acquisition.html">1. Acquisition</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/acquisition.html#gaussian-lcb">1.1. <code class="xref py py-class docutils literal notranslate"><span class="pre">gaussian_lcb</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/acquisition.html#gaussian-pi">1.2. <code class="xref py py-class docutils literal notranslate"><span class="pre">gaussian_pi</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/acquisition.html#gaussian-ei">1.3. <code class="xref py py-class docutils literal notranslate"><span class="pre">gaussian_ei</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/bayessearchcv.html">2. BayesSearchCV, a GridSearchCV compatible estimator</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules/callbacks.html">3. Callbacks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/callbacks.html#monitoring-callbacks">3.1. Monitoring callbacks</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/callbacks.html#early-stopping-callbacks">3.2. Early stopping callbacks</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/callbacks.html#other-callbacks">3.3. Other callbacks</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/optimizer.html">4. Optimizer, an ask-and-tell interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules/minimize_functions.html">5. <code class="docutils literal notranslate"><span class="pre">skopt</span></code>’s top level minimization functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/minimize_functions.html#dummy-minimize">5.1. <code class="xref py py-class docutils literal notranslate"><span class="pre">dummy_minimize</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/minimize_functions.html#forest-minimize">5.2. <code class="xref py py-class docutils literal notranslate"><span class="pre">forest_minimize</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/minimize_functions.html#gbrt-minimize">5.3. <code class="xref py py-class docutils literal notranslate"><span class="pre">gbrt_minimize</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/minimize_functions.html#gp-minimize">5.4. <code class="xref py py-class docutils literal notranslate"><span class="pre">gp_minimize</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/plots.html">6. Plotting tools</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/plots.html#plot-convergence">6.1. plot_convergence</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/plots.html#plot-evaluations">6.2. plot_evaluations</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/plots.html#plot-objective">6.3. plot_objective</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/plots.html#plot-regret">6.4. plot_regret</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/space.html">7. Space</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/space.html#real">7.1. <code class="xref py py-class docutils literal notranslate"><span class="pre">Real</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/space.html#integer">7.2. <code class="xref py py-class docutils literal notranslate"><span class="pre">Integer</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/space.html#categorical">7.3. <code class="xref py py-class docutils literal notranslate"><span class="pre">Categorical</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/utils.html">8. Utility functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#use-named-args">8.1. <code class="xref py py-func docutils literal notranslate"><span class="pre">use_named_args()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#dump">8.2. <code class="xref py py-func docutils literal notranslate"><span class="pre">dump()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#load">8.3. <code class="xref py py-func docutils literal notranslate"><span class="pre">load()</span></code></a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<footer class="sk-content-footer">
© 2017 - 2020, scikit-optimize contributors (BSD License).
<a href="_sources/user_guide.rst.txt" rel="nofollow">Show this page source</a>
</footer>
</div>
</div>
</div>
<script src="_static/js/vendor/bootstrap.min.js"></script>
<script>
$(document).ready(function() {
/* Add a [>>>] button on the top-right corner of code sampler to hide
* the >>> and ... prompts and the output and thus make the code
* copyable. */
var div = $('.highlight-python .highlight,' +
'.highlight-python3 .highlight,' +
'.highlight-pycon .highlight,' +
'.highlight-default .highlight')
var pre = div.find('pre');
// get the styles from the current theme
pre.parent().parent().css('position', 'relative');
var hide_text = 'Hide prompts and outputs';
var show_text = 'Show prompts and outputs';
// create and add the button to all the code blocks that contain >>>
div.each(function(index) {
var jthis = $(this);
if (jthis.find('.gp').length > 0) {
var button = $('<span class="copybutton">>>></span>');
button.attr('title', hide_text);
button.data('hidden', 'false');
jthis.prepend(button);
}
// tracebacks (.gt) contain bare text elements that need to be
// wrapped in a span to work with .nextUntil() (see later)
jthis.find('pre:has(.gt)').contents().filter(function() {
return ((this.nodeType == 3) && (this.data.trim().length > 0));
}).wrap('<span>');
});
// define the behavior of the button when it's clicked
$('.copybutton').click(function(e){
e.preventDefault();
var button = $(this);
if (button.data('hidden') === 'false') {
// hide the code output
button.parent().find('.go, .gp, .gt').hide();
button.next('pre').find('.gt').nextUntil('.gp, .go').css('visibility', 'hidden');
button.css('text-decoration', 'line-through');
button.attr('title', show_text);
button.data('hidden', 'true');
} else {
// show the code output
button.parent().find('.go, .gp, .gt').show();
button.next('pre').find('.gt').nextUntil('.gp, .go').css('visibility', 'visible');
button.css('text-decoration', 'none');
button.attr('title', hide_text);
button.data('hidden', 'false');
}
});
/*** Add permalink buttons next to glossary terms ***/
$('dl.glossary > dt[id]').append(function() {
return ('<a class="headerlink" href="#' +
this.getAttribute('id') +
'" title="Permalink to this term">¶</a>');
});
/*** Hide navbar when scrolling down ***/
// Returns true when headerlink target matches hash in url
(function() {
hashTargetOnTop = function() {
var hash = window.location.hash;
if ( hash.length < 2 ) { return false; }
var target = document.getElementById( hash.slice(1) );
if ( target === null ) { return false; }
var top = target.getBoundingClientRect().top;
return (top < 2) && (top > -2);
};
// Hide navbar on load if hash target is on top
var navBar = document.getElementById("navbar");
var navBarToggler = document.getElementById("sk-navbar-toggler");
var navBarHeightHidden = "-" + navBar.getBoundingClientRect().height + "px";
var $window = $(window);
hideNavBar = function() {
navBar.style.top = navBarHeightHidden;
};
showNavBar = function() {
navBar.style.top = "0";
}
if (hashTargetOnTop()) {
hideNavBar()
}
var prevScrollpos = window.pageYOffset;
hideOnScroll = function(lastScrollTop) {
if (($window.width() < 768) && (navBarToggler.getAttribute("aria-expanded") === 'true')) {
return;
}
if (lastScrollTop > 2 && (prevScrollpos <= lastScrollTop) || hashTargetOnTop()){
hideNavBar()
} else {
showNavBar()
}
prevScrollpos = lastScrollTop;
};
/*** high performance scroll event listener***/
var raf = window.requestAnimationFrame ||
window.webkitRequestAnimationFrame ||
window.mozRequestAnimationFrame ||
window.msRequestAnimationFrame ||
window.oRequestAnimationFrame;
var lastScrollTop = $window.scrollTop();
if (raf) {
loop();
}
function loop() {
var scrollTop = $window.scrollTop();
if (lastScrollTop === scrollTop) {
raf(loop);
return;
} else {
lastScrollTop = scrollTop;
hideOnScroll(lastScrollTop);
raf(loop);
}
}
})();
});
</script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js"></script>
<script src="https://scikit-optimize.github.io/versionwarning.js"></script>
</body>
</html>