Skip to content

Commit be2cc1a

Browse files
committed
Pushing the docs to dev/ for branch: master, commit 6ccd1fc11ac874f75aadc95aac822cb10fac90f4
1 parent df36b30 commit be2cc1a

File tree

123 files changed

+386
-464
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

123 files changed

+386
-464
lines changed
Binary file not shown.
Binary file not shown.
7.93 KB
Binary file not shown.
Loading
Loading
Loading
Loading
Loading

dev/_modules/skopt/space/transformers.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -382,6 +382,8 @@ <h1>Source code for skopt.space.transformers</h1><div class="highlight"><pre>
382382
<span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">any</span><span class="p">(</span><span class="n">X</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">low</span> <span class="o">-</span> <span class="mf">1e-8</span><span class="p">):</span>
383383
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;All values should&quot;</span>
384384
<span class="s2">&quot;be greater than </span><span class="si">%f</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">low</span><span class="p">)</span>
385+
<span class="k">if</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">high</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">low</span><span class="p">)</span> <span class="o">==</span> <span class="mf">0.</span><span class="p">:</span>
386+
<span class="k">return</span> <span class="n">X</span> <span class="o">*</span> <span class="mf">0.</span>
385387
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_int</span><span class="p">:</span>
386388
<span class="k">return</span> <span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">round</span><span class="p">(</span><span class="n">X</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">int</span><span class="p">)</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">low</span><span class="p">)</span> <span class="o">/</span>\
387389
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">high</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">low</span><span class="p">)</span>

dev/_modules/skopt/utils.html

Lines changed: 28 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -329,9 +329,8 @@ <h1>Source code for skopt.utils</h1><div class="highlight"><pre>
329329

330330

331331
<div class="viewcode-block" id="expected_minimum"><a class="viewcode-back" href="../../modules/generated/skopt.utils.expected_minimum.html#skopt.expected_minimum">[docs]</a><span class="k">def</span> <span class="nf">expected_minimum</span><span class="p">(</span><span class="n">res</span><span class="p">,</span> <span class="n">n_random_starts</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span> <span class="n">random_state</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
332-
<span class="sd">&quot;&quot;&quot;</span>
333-
<span class="sd"> Compute the minimum over the predictions of the last surrogate model.</span>
334-
<span class="sd"> Uses `expected_minimum_random_sampling` with `n_random_starts`=100000,</span>
332+
<span class="sd">&quot;&quot;&quot;Compute the minimum over the predictions of the last surrogate model.</span>
333+
<span class="sd"> Uses `expected_minimum_random_sampling` with `n_random_starts` = 100000,</span>
335334
<span class="sd"> when the space contains any categorical values.</span>
336335

337336
<span class="sd"> .. note::</span>
@@ -460,17 +459,15 @@ <h1>Source code for skopt.utils</h1><div class="highlight"><pre>
460459

461460

462461
<div class="viewcode-block" id="cook_estimator"><a class="viewcode-back" href="../../modules/generated/skopt.utils.cook_estimator.html#skopt.cook_estimator">[docs]</a><span class="k">def</span> <span class="nf">cook_estimator</span><span class="p">(</span><span class="n">base_estimator</span><span class="p">,</span> <span class="n">space</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
463-
<span class="sd">&quot;&quot;&quot;</span>
464-
<span class="sd"> Cook a default estimator.</span>
462+
<span class="sd">&quot;&quot;&quot;Cook a default estimator.</span>
465463

466464
<span class="sd"> For the special base_estimator called &quot;DUMMY&quot; the return value is None.</span>
467465
<span class="sd"> This corresponds to sampling points at random, hence there is no need</span>
468466
<span class="sd"> for an estimator.</span>
469467

470468
<span class="sd"> Parameters</span>
471469
<span class="sd"> ----------</span>
472-
<span class="sd"> base_estimator : &quot;GP&quot;, &quot;RF&quot;, &quot;ET&quot;, &quot;GBRT&quot;, &quot;DUMMY&quot;</span>
473-
<span class="sd"> or sklearn regressor</span>
470+
<span class="sd"> base_estimator : &quot;GP&quot;, &quot;RF&quot;, &quot;ET&quot;, &quot;GBRT&quot;, &quot;DUMMY&quot; or sklearn regressor</span>
474471
<span class="sd"> Should inherit from `sklearn.base.RegressorMixin`.</span>
475472
<span class="sd"> In addition the `predict` method should have an optional `return_std`</span>
476473
<span class="sd"> argument, which returns `std(Y | x)`` along with `E[Y | x]`.</span>
@@ -535,15 +532,14 @@ <h1>Source code for skopt.utils</h1><div class="highlight"><pre>
535532

536533

537534
<div class="viewcode-block" id="cook_initial_point_generator"><a class="viewcode-back" href="../../modules/generated/skopt.utils.cook_initial_point_generator.html#skopt.cook_initial_point_generator">[docs]</a><span class="k">def</span> <span class="nf">cook_initial_point_generator</span><span class="p">(</span><span class="n">generator</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
538-
<span class="sd">&quot;&quot;&quot;</span>
539-
<span class="sd"> Cook a default initial point generator.</span>
535+
<span class="sd">&quot;&quot;&quot;Cook a default initial point generator.</span>
540536

541537
<span class="sd"> For the special generator called &quot;random&quot; the return value is None.</span>
542538

543539
<span class="sd"> Parameters</span>
544540
<span class="sd"> ----------</span>
545-
<span class="sd"> generator : &quot;lhs&quot;, &quot;sobol&quot;, &quot;halton&quot;, &quot;hammersly&quot;, &quot;grid&quot;, &quot;random&quot;</span>
546-
<span class="sd"> or InitialPointGenerator instance&quot;</span>
541+
<span class="sd"> generator : &quot;lhs&quot;, &quot;sobol&quot;, &quot;halton&quot;, &quot;hammersly&quot;, &quot;grid&quot;, &quot;random&quot; \</span>
542+
<span class="sd"> or InitialPointGenerator instance&quot;</span>
547543
<span class="sd"> Should inherit from `skopt.sampler.InitialPointGenerator`.</span>
548544

549545
<span class="sd"> kwargs : dict</span>
@@ -721,37 +717,30 @@ <h1>Source code for skopt.utils</h1><div class="highlight"><pre>
721717
<span class="sd"> &quot;&quot;&quot;</span>
722718
<span class="n">space</span> <span class="o">=</span> <span class="n">Space</span><span class="p">(</span><span class="n">dimensions</span><span class="p">)</span>
723719
<span class="n">transformed_dimensions</span> <span class="o">=</span> <span class="p">[]</span>
724-
<span class="k">if</span> <span class="n">space</span><span class="o">.</span><span class="n">is_categorical</span><span class="p">:</span>
725-
<span class="c1"># recreate the space and explicitly set transform to &quot;string&quot;</span>
726-
<span class="c1"># this is a special case for GP based regressors</span>
727-
<span class="k">for</span> <span class="n">dimension</span> <span class="ow">in</span> <span class="n">space</span><span class="p">:</span>
720+
<span class="k">for</span> <span class="n">dimension</span> <span class="ow">in</span> <span class="n">space</span><span class="o">.</span><span class="n">dimensions</span><span class="p">:</span>
721+
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">dimension</span><span class="p">,</span> <span class="n">Categorical</span><span class="p">):</span>
728722
<span class="n">transformed_dimensions</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">Categorical</span><span class="p">(</span><span class="n">dimension</span><span class="o">.</span><span class="n">categories</span><span class="p">,</span>
729723
<span class="n">dimension</span><span class="o">.</span><span class="n">prior</span><span class="p">,</span>
730724
<span class="n">name</span><span class="o">=</span><span class="n">dimension</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
731-
<span class="n">transform</span><span class="o">=</span><span class="s2">&quot;string&quot;</span><span class="p">))</span>
732-
733-
<span class="k">else</span><span class="p">:</span>
734-
<span class="k">for</span> <span class="n">dimension</span> <span class="ow">in</span> <span class="n">space</span><span class="o">.</span><span class="n">dimensions</span><span class="p">:</span>
735-
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">dimension</span><span class="p">,</span> <span class="n">Categorical</span><span class="p">):</span>
736-
<span class="n">transformed_dimensions</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dimension</span><span class="p">)</span>
737-
<span class="c1"># To make sure that GP operates in the [0, 1] space</span>
738-
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">dimension</span><span class="p">,</span> <span class="n">Real</span><span class="p">):</span>
739-
<span class="n">transformed_dimensions</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
740-
<span class="n">Real</span><span class="p">(</span><span class="n">dimension</span><span class="o">.</span><span class="n">low</span><span class="p">,</span> <span class="n">dimension</span><span class="o">.</span><span class="n">high</span><span class="p">,</span> <span class="n">dimension</span><span class="o">.</span><span class="n">prior</span><span class="p">,</span>
741-
<span class="n">name</span><span class="o">=</span><span class="n">dimension</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
742-
<span class="n">transform</span><span class="o">=</span><span class="s2">&quot;normalize&quot;</span><span class="p">,</span>
743-
<span class="n">dtype</span><span class="o">=</span><span class="n">dimension</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span>
744-
<span class="p">)</span>
745-
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">dimension</span><span class="p">,</span> <span class="n">Integer</span><span class="p">):</span>
746-
<span class="n">transformed_dimensions</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
747-
<span class="n">Integer</span><span class="p">(</span><span class="n">dimension</span><span class="o">.</span><span class="n">low</span><span class="p">,</span> <span class="n">dimension</span><span class="o">.</span><span class="n">high</span><span class="p">,</span>
748-
<span class="n">name</span><span class="o">=</span><span class="n">dimension</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
749-
<span class="n">transform</span><span class="o">=</span><span class="s2">&quot;normalize&quot;</span><span class="p">,</span>
750-
<span class="n">dtype</span><span class="o">=</span><span class="n">dimension</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span>
751-
<span class="p">)</span>
752-
<span class="k">else</span><span class="p">:</span>
753-
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Unknown dimension type &quot;</span>
754-
<span class="s2">&quot;(</span><span class="si">%s</span><span class="s2">)&quot;</span> <span class="o">%</span> <span class="nb">type</span><span class="p">(</span><span class="n">dimension</span><span class="p">))</span>
725+
<span class="n">transform</span><span class="o">=</span><span class="s2">&quot;normalize&quot;</span><span class="p">))</span>
726+
<span class="c1"># To make sure that GP operates in the [0, 1] space</span>
727+
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">dimension</span><span class="p">,</span> <span class="n">Real</span><span class="p">):</span>
728+
<span class="n">transformed_dimensions</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
729+
<span class="n">Real</span><span class="p">(</span><span class="n">dimension</span><span class="o">.</span><span class="n">low</span><span class="p">,</span> <span class="n">dimension</span><span class="o">.</span><span class="n">high</span><span class="p">,</span> <span class="n">dimension</span><span class="o">.</span><span class="n">prior</span><span class="p">,</span>
730+
<span class="n">name</span><span class="o">=</span><span class="n">dimension</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
731+
<span class="n">transform</span><span class="o">=</span><span class="s2">&quot;normalize&quot;</span><span class="p">,</span>
732+
<span class="n">dtype</span><span class="o">=</span><span class="n">dimension</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span>
733+
<span class="p">)</span>
734+
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">dimension</span><span class="p">,</span> <span class="n">Integer</span><span class="p">):</span>
735+
<span class="n">transformed_dimensions</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
736+
<span class="n">Integer</span><span class="p">(</span><span class="n">dimension</span><span class="o">.</span><span class="n">low</span><span class="p">,</span> <span class="n">dimension</span><span class="o">.</span><span class="n">high</span><span class="p">,</span>
737+
<span class="n">name</span><span class="o">=</span><span class="n">dimension</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
738+
<span class="n">transform</span><span class="o">=</span><span class="s2">&quot;normalize&quot;</span><span class="p">,</span>
739+
<span class="n">dtype</span><span class="o">=</span><span class="n">dimension</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span>
740+
<span class="p">)</span>
741+
<span class="k">else</span><span class="p">:</span>
742+
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Unknown dimension type &quot;</span>
743+
<span class="s2">&quot;(</span><span class="si">%s</span><span class="s2">)&quot;</span> <span class="o">%</span> <span class="nb">type</span><span class="p">(</span><span class="n">dimension</span><span class="p">))</span>
755744

756745
<span class="k">return</span> <span class="n">Space</span><span class="p">(</span><span class="n">transformed_dimensions</span><span class="p">)</span>
757746

dev/_sources/auto_examples/ask-and-tell.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ and report the value back to the optimizer:
175175
fun: -0.032758350111535384
176176
func_vals: array([-0.03275835])
177177
models: []
178-
random_state: RandomState(MT19937) at 0x7FAB4D60ED40
178+
random_state: RandomState(MT19937) at 0x7F30E5530D40
179179
space: Space([Real(low=-2.0, high=2.0, prior='uniform', transform='identity')])
180180
specs: None
181181
x: [-1.7121321838148869]
@@ -312,7 +312,7 @@ meantime:
312312
313313
.. rst-class:: sphx-glr-timing
314314

315-
**Total running time of the script:** ( 0 minutes 4.849 seconds)
315+
**Total running time of the script:** ( 0 minutes 4.606 seconds)
316316

317317
**Estimated memory usage:** 8 MB
318318

dev/_sources/auto_examples/bayesian-optimization.rst.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -267,13 +267,13 @@ provide the following information:
267267
n_restarts_optimizer=2, noise=0.010000000000000002,
268268
normalize_y=True, optimizer='fmin_l_bfgs_b',
269269
random_state=822569775)]
270-
random_state: RandomState(MT19937) at 0x7FAB30019640
270+
random_state: RandomState(MT19937) at 0x7F30E7AE3D40
271271
space: Space([Real(low=-2.0, high=2.0, prior='uniform', transform='normalize')])
272-
specs: {'args': {'func': <function f at 0x7fab2b90c310>, 'dimensions': Space([Real(low=-2.0, high=2.0, prior='uniform', transform='normalize')]), 'base_estimator': GaussianProcessRegressor(alpha=1e-10, copy_X_train=True,
272+
specs: {'args': {'func': <function f at 0x7f30c9742b80>, 'dimensions': Space([Real(low=-2.0, high=2.0, prior='uniform', transform='normalize')]), 'base_estimator': GaussianProcessRegressor(alpha=1e-10, copy_X_train=True,
273273
kernel=1**2 * Matern(length_scale=1, nu=2.5),
274274
n_restarts_optimizer=2, noise=0.010000000000000002,
275275
normalize_y=True, optimizer='fmin_l_bfgs_b',
276-
random_state=822569775), 'n_calls': 15, 'n_random_starts': 5, 'n_initial_points': 10, 'initial_point_generator': 'random', 'acq_func': 'EI', 'acq_optimizer': 'auto', 'x0': None, 'y0': None, 'random_state': RandomState(MT19937) at 0x7FAB30019640, 'verbose': False, 'callback': None, 'n_points': 10000, 'n_restarts_optimizer': 5, 'xi': 0.01, 'kappa': 1.96, 'n_jobs': 1, 'model_queue_size': None}, 'function': 'base_minimize'}
276+
random_state=822569775), 'n_calls': 15, 'n_random_starts': 5, 'n_initial_points': 10, 'initial_point_generator': 'random', 'acq_func': 'EI', 'acq_optimizer': 'auto', 'x0': None, 'y0': None, 'random_state': RandomState(MT19937) at 0x7F30E7AE3D40, 'verbose': False, 'callback': None, 'n_points': 10000, 'n_restarts_optimizer': 5, 'xi': 0.01, 'kappa': 1.96, 'n_jobs': 1, 'model_queue_size': None}, 'function': 'base_minimize'}
277277
x: [-0.35076964188527904]
278278
x_iters: [[-0.009345334109402526], [1.2713537644662787], [0.4484475787090836], [1.0854396754496047], [1.4426790855107496], [0.9698921802985794], [-0.4464493263345517], [-0.6474638284799423], [-0.35076964188527904], [-0.28714767658880325], [-0.2968537755362253], [-2.0], [2.0], [-1.3149517825054502], [-0.32181607448732485]]
279279
@@ -305,7 +305,7 @@ the last iteration:
305305
.. code-block:: none
306306
307307
308-
<matplotlib.axes._subplots.AxesSubplot object at 0x7fab29040640>
308+
<matplotlib.axes._subplots.AxesSubplot object at 0x7f30c0f93e50>
309309
310310
311311
@@ -476,7 +476,7 @@ because the GP does not gain anything more by further exploration:
476476

477477
.. rst-class:: sphx-glr-timing
478478

479-
**Total running time of the script:** ( 0 minutes 3.721 seconds)
479+
**Total running time of the script:** ( 0 minutes 3.932 seconds)
480480

481481
**Estimated memory usage:** 8 MB
482482

dev/_sources/auto_examples/exploration-vs-exploitation.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -562,7 +562,7 @@ recalculated.
562562

563563
.. rst-class:: sphx-glr-timing
564564

565-
**Total running time of the script:** ( 0 minutes 34.142 seconds)
565+
**Total running time of the script:** ( 0 minutes 35.732 seconds)
566566

567567
**Estimated memory usage:** 8 MB
568568

0 commit comments

Comments
 (0)