Skip to content

Commit 2381d44

Browse files
CI: Update docs for v1.25.0 (ec7433286915d71bb7bb8f4e38758eca5c7171f6)
1 parent 327e470 commit 2381d44

File tree

8 files changed

+2020
-2674
lines changed

8 files changed

+2020
-2674
lines changed

convergence.svg

Lines changed: 316 additions & 475 deletions
Loading

convergence2.svg

Lines changed: 215 additions & 303 deletions
Loading

doc/index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

doc/sambo/index.html

Lines changed: 80 additions & 30 deletions
Large diffs are not rendered by default.

doc/sambo/plot.html

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
7171
<details class="source">
7272
<summary>
7373
<span>Expand source code</span>
74-
<a href="https://github.com/sambo-optimization/sambo/blob/38d5794db298ccc27527594e6b54c7c1106e63be/sambo/plot.py#L37-L102" class="git-link" target="_blank">Browse git</a>
74+
<a href="https://github.com/sambo-optimization/sambo/blob/ec7433286915d71bb7bb8f4e38758eca5c7171f6/sambo/plot.py#L38-L103" class="git-link" target="_blank">Browse git</a>
7575
</summary>
7676
<pre><code class="python">def plot_convergence(
7777
*results: OptimizeResult | tuple[str, OptimizeResult],
@@ -162,13 +162,13 @@ <h2 id="example">Example</h2>
162162
<p><img alt="" loading="lazy" src="/convergence.svg"></p></div>
163163
</dd>
164164
<dt id="sambo.plot.plot_evaluations"><code class="name flex">
165-
<span>def <span class="ident">plot_evaluations</span></span>(<span>result: sambo._util.OptimizeResult,<br>*,<br>bins: int = 10,<br>names: list[str] | None = None,<br>plot_dims: list[int] | None = None,<br>jitter: float = 0.02,<br>size: int = 2,<br>cmap: str = 'summer') ‑> matplotlib.figure.Figure</span>
165+
<span>def <span class="ident">plot_evaluations</span></span>(<span>result: sambo._util.OptimizeResult,<br>*,<br>bins: int = 10,<br>names: list[str] | None = None,<br>plot_dims: list[int] | None = None,<br>jitter: float = 0.02,<br>size: int = 1.7,<br>cmap: str = 'summer') ‑> matplotlib.figure.Figure</span>
166166
</code></dt>
167167
<dd>
168168
<details class="source">
169169
<summary>
170170
<span>Expand source code</span>
171-
<a href="https://github.com/sambo-optimization/sambo/blob/38d5794db298ccc27527594e6b54c7c1106e63be/sambo/plot.py#L649-L750" class="git-link" target="_blank">Browse git</a>
171+
<a href="https://github.com/sambo-optimization/sambo/blob/ec7433286915d71bb7bb8f4e38758eca5c7171f6/sambo/plot.py#L656-L757" class="git-link" target="_blank">Browse git</a>
172172
</summary>
173173
<pre><code class="python">def plot_evaluations(
174174
result: OptimizeResult,
@@ -177,7 +177,7 @@ <h2 id="example">Example</h2>
177177
names: Optional[list[str]] = None,
178178
plot_dims: Optional[list[int]] = None,
179179
jitter: float = .02,
180-
size: int = 2,
180+
size: int = _DEFAULT_SUBPLOT_SIZE,
181181
cmap: str = &#39;summer&#39;,
182182
) -&gt; Figure:
183183
&#34;&#34;&#34;Visualize the order in which points were evaluated during optimization.
@@ -317,13 +317,13 @@ <h2 id="example">Example</h2>
317317
<p><img alt="" loading="lazy" src="/evaluations.svg"></p></div>
318318
</dd>
319319
<dt id="sambo.plot.plot_objective"><code class="name flex">
320-
<span>def <span class="ident">plot_objective</span></span>(<span>result: sambo._util.OptimizeResult,<br>*,<br>levels: int = 10,<br>resolution: int = 16,<br>n_samples: int = 250,<br>estimator: str | sambo._util._SklearnLikeRegressor | None = None,<br>size: float = 2,<br>zscale: Literal['linear', 'log'] = 'linear',<br>names: list[str] | None = None,<br>true_minimum: list[float] | list[list[float]] | None = None,<br>plot_dims: list[int] | None = None,<br>plot_max_points: int = 200,<br>jitter: float = 0.02,<br>cmap: str = 'viridis_r') ‑> matplotlib.figure.Figure</span>
320+
<span>def <span class="ident">plot_objective</span></span>(<span>result: sambo._util.OptimizeResult,<br>*,<br>levels: int = 10,<br>resolution: int = 16,<br>n_samples: int = 250,<br>estimator: str | sambo._util._SklearnLikeRegressor | None = None,<br>size: float = 1.7,<br>zscale: Literal['linear', 'log'] = 'linear',<br>names: list[str] | None = None,<br>true_minimum: list[float] | list[list[float]] | None = None,<br>plot_dims: list[int] | None = None,<br>plot_max_points: int = 200,<br>jitter: float = 0.02,<br>cmap: str = 'viridis_r') ‑> matplotlib.figure.Figure</span>
321321
</code></dt>
322322
<dd>
323323
<details class="source">
324324
<summary>
325325
<span>Expand source code</span>
326-
<a href="https://github.com/sambo-optimization/sambo/blob/38d5794db298ccc27527594e6b54c7c1106e63be/sambo/plot.py#L465-L646" class="git-link" target="_blank">Browse git</a>
326+
<a href="https://github.com/sambo-optimization/sambo/blob/ec7433286915d71bb7bb8f4e38758eca5c7171f6/sambo/plot.py#L471-L653" class="git-link" target="_blank">Browse git</a>
327327
</summary>
328328
<pre><code class="python">def plot_objective(
329329
result: OptimizeResult,
@@ -332,7 +332,7 @@ <h2 id="example">Example</h2>
332332
resolution: int = 16,
333333
n_samples: int = 250,
334334
estimator: Optional[str | _SklearnLikeRegressor] = None,
335-
size: float = 2,
335+
size: float = _DEFAULT_SUBPLOT_SIZE,
336336
zscale: Literal[&#39;linear&#39;, &#39;log&#39;] = &#39;linear&#39;,
337337
names: Optional[list[str]] = None,
338338
true_minimum: Optional[list[float] | list[list[float]]] = None,
@@ -471,8 +471,9 @@ <h2 id="example">Example</h2>
471471
if estimator is None and result_estimator is not None:
472472
estimator = result_estimator
473473
else:
474+
_estimator_arg = estimator
474475
estimator = _estimator_factory(estimator, bounds, rng=0)
475-
if result_estimator is None:
476+
if result_estimator is None and _estimator_arg is None:
476477
warnings.warn(
477478
&#39;The optimization result process does not appear to have been &#39;
478479
&#39;driven by a model. You can still still observe partial dependence &#39;
@@ -503,7 +504,7 @@ <h2 id="example">Example</h2>
503504
x, y = x_samples[:, j], x_samples[:, i]
504505
if jitter:
505506
x, y = _maybe_jitter(jitter, (j, x), (i, y), space=space)
506-
ax.scatter(x, y, c=&#39;k&#39;, s=12, lw=0, alpha=.4)
507+
ax.scatter(x, y, c=&#39;k&#39;, s=12, lw=0, alpha=.5)
507508

508509
_format_scatter_plot_axes(fig, axs, space, plot_dims=plot_dims, dim_labels=names, size=size)
509510
return fig</code></pre>
@@ -588,7 +589,7 @@ <h2 id="example">Example</h2>
588589
<details class="source">
589590
<summary>
590591
<span>Expand source code</span>
591-
<a href="https://github.com/sambo-optimization/sambo/blob/38d5794db298ccc27527594e6b54c7c1106e63be/sambo/plot.py#L127-L202" class="git-link" target="_blank">Browse git</a>
592+
<a href="https://github.com/sambo-optimization/sambo/blob/ec7433286915d71bb7bb8f4e38758eca5c7171f6/sambo/plot.py#L128-L203" class="git-link" target="_blank">Browse git</a>
592593
</summary>
593594
<pre><code class="python">def plot_regret(
594595
*results: OptimizeResult | tuple[str, OptimizeResult],

0 commit comments

Comments
 (0)