Skip to content

Commit bc12ea5

Browse files
bartzbeielsteinbartzbeielstein
committed
Deployed a009e7c with MkDocs version: 1.6.0
1 parent da03669 commit bc12ea5

5 files changed

Lines changed: 166 additions & 166 deletions

File tree

‎reference/spotpython/design/sobol/index.html‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5254,7 +5254,8 @@ <h2 id="spotpython.design.sobol.Sobol" class="doc doc-heading">
52545254

52555255
<details class="quote">
52565256
<summary>Source code in <code>spotpython/design/sobol.py</code></summary>
5257-
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 7</span>
5257+
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 6</span>
5258+
<span class="normal"> 7</span>
52585259
<span class="normal"> 8</span>
52595260
<span class="normal"> 9</span>
52605261
<span class="normal">10</span>
@@ -5303,8 +5304,7 @@ <h2 id="spotpython.design.sobol.Sobol" class="doc doc-heading">
53035304
<span class="normal">53</span>
53045305
<span class="normal">54</span>
53055306
<span class="normal">55</span>
5306-
<span class="normal">56</span>
5307-
<span class="normal">57</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">Sobol</span><span class="p">(</span><span class="n">Designs</span><span class="p">):</span>
5307+
<span class="normal">56</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">Sobol</span><span class="p">(</span><span class="n">Designs</span><span class="p">):</span>
53085308
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
53095309
<span class="sd"> Super class for sobol designs.</span>
53105310

@@ -5428,7 +5428,8 @@ <h3 id="spotpython.design.sobol.Sobol.__init__" class="doc doc-heading">
54285428

54295429
<details class="quote">
54305430
<summary>Source code in <code>spotpython/design/sobol.py</code></summary>
5431-
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">16</span>
5431+
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">15</span>
5432+
<span class="normal">16</span>
54325433
<span class="normal">17</span>
54335434
<span class="normal">18</span>
54345435
<span class="normal">19</span>
@@ -5437,8 +5438,7 @@ <h3 id="spotpython.design.sobol.Sobol.__init__" class="doc doc-heading">
54375438
<span class="normal">22</span>
54385439
<span class="normal">23</span>
54395440
<span class="normal">24</span>
5440-
<span class="normal">25</span>
5441-
<span class="normal">26</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">k</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">2</span><span class="p">,</span> <span class="n">seed</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">123</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
5441+
<span class="normal">25</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">k</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">2</span><span class="p">,</span> <span class="n">seed</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">123</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
54425442
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
54435443
<span class="sd"> Initializes a sobol design object.</span>
54445444

@@ -5497,7 +5497,7 @@ <h3 id="spotpython.design.sobol.Sobol.generate_sobol_design" class="doc doc-head
54975497
<tr class="doc-section-item">
54985498
<td><code>seed</code></td>
54995499
<td>
5500-
<code><span title="typing.Optional">Optional</span>[int]</code>
5500+
<code>Optional[int]</code>
55015501
</td>
55025502
<td>
55035503
<div class="doc-md-description">
@@ -5555,7 +5555,8 @@ <h3 id="spotpython.design.sobol.Sobol.generate_sobol_design" class="doc doc-head
55555555

55565556
<details class="quote">
55575557
<summary>Source code in <code>spotpython/design/sobol.py</code></summary>
5558-
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">28</span>
5558+
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">27</span>
5559+
<span class="normal">28</span>
55595560
<span class="normal">29</span>
55605561
<span class="normal">30</span>
55615562
<span class="normal">31</span>
@@ -5583,8 +5584,7 @@ <h3 id="spotpython.design.sobol.Sobol.generate_sobol_design" class="doc doc-head
55835584
<span class="normal">53</span>
55845585
<span class="normal">54</span>
55855586
<span class="normal">55</span>
5586-
<span class="normal">56</span>
5587-
<span class="normal">57</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">generate_sobol_design</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n_points</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">seed</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
5587+
<span class="normal">56</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">generate_sobol_design</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n_points</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">seed</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
55885588
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Generates a Sobol sequence design</span>
55895589

55905590
<span class="sd"> Args:</span>

‎reference/spotpython/spot/spot/index.html‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5878,7 +5878,7 @@ <h2 id="spotpython.spot.spot.Spot" class="doc doc-heading">
58785878
</td>
58795879
<td>
58805880
<div class="doc-md-description">
5881-
<p>surrogate model. If <code>None</code>, spotpython&rsquo;s <code>kriging</code> is used. Default value is <code>None</code>.</p>
5881+
<p>surrogate model. If <code>None</code>, spotpython&rsquo;s <code>Kriging</code> is used. Default value is <code>None</code>.</p>
58825882
</div>
58835883
</td>
58845884
<td>
@@ -8825,7 +8825,7 @@ <h2 id="spotpython.spot.spot.Spot" class="doc doc-heading">
88258825
<span class="sd"> information about the optimizer stored as a dictionary.</span>
88268826
<span class="sd"> Default value is `optimizer_control_init()`.</span>
88278827
<span class="sd"> surrogate (object):</span>
8828-
<span class="sd"> surrogate model. If `None`, spotpython&#39;s `kriging` is used. Default value is `None`.</span>
8828+
<span class="sd"> surrogate model. If `None`, spotpython&#39;s `Kriging` is used. Default value is `None`.</span>
88298829
<span class="sd"> surrogate_control (Dict[str, Union[int, float]]):</span>
88308830
<span class="sd"> surrogate model information stored as a dictionary.</span>
88318831
<span class="sd"> Default value is `surrogate_control_init()`.</span>
@@ -9122,7 +9122,7 @@ <h2 id="spotpython.spot.spot.Spot" class="doc doc-heading">
91229122
<span class="c1"># Surrogate related information:</span>
91239123
<span class="bp">self</span><span class="o">.</span><span class="n">surrogate</span> <span class="o">=</span> <span class="n">surrogate</span>
91249124
<span class="c1"># If no surrogate model is specified, use the internal</span>
9125-
<span class="c1"># spotpython kriging surrogate:</span>
9125+
<span class="c1"># spotpython Kriging surrogate:</span>
91269126
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">surrogate</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
91279127
<span class="c1"># Call kriging with surrogate_control parameters:</span>
91289128
<span class="bp">self</span><span class="o">.</span><span class="n">surrogate</span> <span class="o">=</span> <span class="n">Kriging</span><span class="p">(</span>
@@ -9213,7 +9213,7 @@ <h2 id="spotpython.spot.spot.Spot" class="doc doc-heading">
92139213
<span class="sd"> 32 show_models False</span>
92149214
<span class="sd"> 33 show_progress True</span>
92159215
<span class="sd"> 34 spot_writer None</span>
9216-
<span class="sd"> 35 surrogate &lt;spotpython.build.kriging.Kriging object at 0x...</span>
9216+
<span class="sd"> 35 surrogate &lt;spotpython.surrogate.kriging.Kriging object at 0x...</span>
92179217
<span class="sd"> 36 surrogate_control {&#39;method&#39;: &quot;regession&quot;, &#39;model_optimizer&#39;: &lt;function ...</span>
92189218
<span class="sd"> 37 tolerance_x 0</span>
92199219
<span class="sd"> 38 upper [1]</span>
@@ -10625,7 +10625,7 @@ <h2 id="spotpython.spot.spot.Spot" class="doc doc-heading">
1062510625
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
1062610626
<span class="sd"> Infill (acquisition) function. Evaluates one point on the surrogate via `surrogate.predict(x.reshape(1,-1))`,</span>
1062710627
<span class="sd"> if `sklearn` surrogates are used or `surrogate.predict(x.reshape(1,-1), return_val=self.infill_criterion)`</span>
10628-
<span class="sd"> if the internal surrogate `kriging` is selected.</span>
10628+
<span class="sd"> if the internal surrogate `Kriging` is selected.</span>
1062910629
<span class="sd"> This method is passed to the optimizer in `suggest_new_X`, i.e., the optimizer is called via</span>
1063010630
<span class="sd"> `self.optimizer(func=self.infill)`.</span>
1063110631

@@ -10642,7 +10642,7 @@ <h2 id="spotpython.spot.spot.Spot" class="doc doc-heading">
1064210642
<span class="sd"> &quot;&quot;&quot;</span>
1064310643
<span class="c1"># Reshape x to have shape (1, -1) because the predict method expects a 2D array</span>
1064410644
<span class="n">X</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span>
10645-
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">surrogate</span><span class="p">,</span> <span class="n">Kriging</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">surrogate</span><span class="p">,</span> <span class="s2">&quot;name&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="o">==</span> <span class="s2">&quot;kriging&quot;</span><span class="p">:</span>
10645+
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">surrogate</span><span class="p">,</span> <span class="n">Kriging</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">surrogate</span><span class="p">,</span> <span class="s2">&quot;name&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="o">==</span> <span class="s2">&quot;Kriging&quot;</span><span class="p">:</span>
1064610646
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">surrogate</span><span class="o">.</span><span class="n">predict</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">return_val</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">infill_criterion</span><span class="p">)</span>
1064710647
<span class="k">else</span><span class="p">:</span>
1064810648
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">surrogate</span><span class="o">.</span><span class="n">predict</span><span class="p">(</span><span class="n">X</span><span class="p">)</span>
@@ -13384,7 +13384,7 @@ <h3 id="spotpython.spot.spot.Spot.get_spot_attributes_as_df" class="doc doc-head
1338413384
<span class="go"> 32 show_models False</span>
1338513385
<span class="go"> 33 show_progress True</span>
1338613386
<span class="go"> 34 spot_writer None</span>
13387-
<span class="go"> 35 surrogate &lt;spotpython.build.kriging.Kriging object at 0x...</span>
13387+
<span class="go"> 35 surrogate &lt;spotpython.surrogate.kriging.Kriging object at 0x...</span>
1338813388
<span class="go"> 36 surrogate_control {&#39;method&#39;: &quot;regession&quot;, &#39;model_optimizer&#39;: &lt;function ...</span>
1338913389
<span class="go"> 37 tolerance_x 0</span>
1339013390
<span class="go"> 38 upper [1]</span>
@@ -13544,7 +13544,7 @@ <h3 id="spotpython.spot.spot.Spot.get_spot_attributes_as_df" class="doc doc-head
1354413544
<span class="sd"> 32 show_models False</span>
1354513545
<span class="sd"> 33 show_progress True</span>
1354613546
<span class="sd"> 34 spot_writer None</span>
13547-
<span class="sd"> 35 surrogate &lt;spotpython.build.kriging.Kriging object at 0x...</span>
13547+
<span class="sd"> 35 surrogate &lt;spotpython.surrogate.kriging.Kriging object at 0x...</span>
1354813548
<span class="sd"> 36 surrogate_control {&#39;method&#39;: &quot;regession&quot;, &#39;model_optimizer&#39;: &lt;function ...</span>
1354913549
<span class="sd"> 37 tolerance_x 0</span>
1355013550
<span class="sd"> 38 upper [1]</span>
@@ -13949,7 +13949,7 @@ <h3 id="spotpython.spot.spot.Spot.infill" class="doc doc-heading">
1394913949

1395013950
<p>Infill (acquisition) function. Evaluates one point on the surrogate via <code>surrogate.predict(x.reshape(1,-1))</code>,
1395113951
if <code>sklearn</code> surrogates are used or <code>surrogate.predict(x.reshape(1,-1), return_val=self.infill_criterion)</code>
13952-
if the internal surrogate <code>kriging</code> is selected.
13952+
if the internal surrogate <code>Kriging</code> is selected.
1395313953
This method is passed to the optimizer in <code>suggest_new_X</code>, i.e., the optimizer is called via
1395413954
<code>self.optimizer(func=self.infill)</code>.</p>
1395513955

@@ -14042,7 +14042,7 @@ <h3 id="spotpython.spot.spot.Spot.infill" class="doc doc-heading">
1404214042
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
1404314043
<span class="sd"> Infill (acquisition) function. Evaluates one point on the surrogate via `surrogate.predict(x.reshape(1,-1))`,</span>
1404414044
<span class="sd"> if `sklearn` surrogates are used or `surrogate.predict(x.reshape(1,-1), return_val=self.infill_criterion)`</span>
14045-
<span class="sd"> if the internal surrogate `kriging` is selected.</span>
14045+
<span class="sd"> if the internal surrogate `Kriging` is selected.</span>
1404614046
<span class="sd"> This method is passed to the optimizer in `suggest_new_X`, i.e., the optimizer is called via</span>
1404714047
<span class="sd"> `self.optimizer(func=self.infill)`.</span>
1404814048

@@ -14059,7 +14059,7 @@ <h3 id="spotpython.spot.spot.Spot.infill" class="doc doc-heading">
1405914059
<span class="sd"> &quot;&quot;&quot;</span>
1406014060
<span class="c1"># Reshape x to have shape (1, -1) because the predict method expects a 2D array</span>
1406114061
<span class="n">X</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span>
14062-
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">surrogate</span><span class="p">,</span> <span class="n">Kriging</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">surrogate</span><span class="p">,</span> <span class="s2">&quot;name&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="o">==</span> <span class="s2">&quot;kriging&quot;</span><span class="p">:</span>
14062+
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">surrogate</span><span class="p">,</span> <span class="n">Kriging</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">surrogate</span><span class="p">,</span> <span class="s2">&quot;name&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="o">==</span> <span class="s2">&quot;Kriging&quot;</span><span class="p">:</span>
1406314063
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">surrogate</span><span class="o">.</span><span class="n">predict</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">return_val</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">infill_criterion</span><span class="p">)</span>
1406414064
<span class="k">else</span><span class="p">:</span>
1406514065
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">surrogate</span><span class="o">.</span><span class="n">predict</span><span class="p">(</span><span class="n">X</span><span class="p">)</span>

‎search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)