Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix in doc of visualise.optimization_stats #1390

Merged
merged 7 commits into from
May 15, 2024
64 changes: 37 additions & 27 deletions pypesto/visualize/optimization_stats.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,19 @@ def optimization_run_properties_one_plot(

Examples
--------
optimization_properties_per_multistart(
result1,
properties_to_plot=['time'],
colors=[.5, .9, .9, .3])

optimization_properties_per_multistart(
result1,
properties_to_plot=['time', 'n_grad'],
colors=[[.5, .9, .9, .3], [.2, .1, .9, .5]])
.. code-block:: python

optimization_run_properties_one_plot(
result1,
properties_to_plot=['time'],
colors=[.5, .9, .9, .3]
)

optimization_run_properties_one_plot(
result1,
properties_to_plot=['time', 'n_grad'],
colors=[[.5, .9, .9, .3], [.2, .1, .9, .5]]
)
"""
if properties_to_plot is None:
properties_to_plot = [
Expand Down Expand Up @@ -156,24 +160,30 @@ def optimization_run_properties_per_multistart(

Examples
--------
optimization_properties_per_multistart(
result1,
properties_to_plot=['time'],
colors=[.5, .9, .9, .3])

optimization_properties_per_multistart(
[result1, result2],
properties_to_plot=['time'],
colors=[[.5, .9, .9, .3], [.2, .1, .9, .5]])

optimization_properties_per_multistart(
result1,
properties_to_plot=['time', 'n_grad'],
colors=[.5, .9, .9, .3])

optimization_properties_per_multistart(
[result1, result2], properties_to_plot=['time', 'n_fval'],
colors=[[.5, .9, .9, .3], [.2, .1, .9, .5]])
.. code-block:: python

optimization_run_properties_per_multistart(
result1,
properties_to_plot=['time'],
colors=[.5, .9, .9, .3]
)

optimization_run_properties_per_multistart(
[result1, result2],
properties_to_plot=['time'],
colors=[[.5, .9, .9, .3], [.2, .1, .9, .5]]
)

optimization_run_properties_per_multistart(
result1,
properties_to_plot=['time', 'n_grad'],
colors=[.5, .9, .9, .3]
)

optimization_run_properties_per_multistart(
[result1, result2], properties_to_plot=['time', 'n_fval'],
colors=[[.5, .9, .9, .3], [.2, .1, .9, .5]]
)
"""
if properties_to_plot is None:
properties_to_plot = [
Expand Down
Loading