Skip to content

Commit 0f01de2

Browse files
author
Circle CI
committed
Update docs for dev (build 4064)
1 parent 69ff297 commit 0f01de2

18 files changed

Lines changed: 40 additions & 31 deletions

File tree

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

dev/_sources/auto_examples/run_minimal_benchmark.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ To run the benchmark, just execute:
6868
<span style="color: #000080; text-decoration-color: #000080; font-weight: bold"> |--gd[lr=0.01]:</span> <span style="color: #808000; text-decoration-color: #808000; font-weight: bold">done (not enough run)</span>
6969
<span style="color: #008000; text-decoration-color: #008000; font-weight: bold">Saving result in: </span>
7070
<span style="color: #008000; text-decoration-color: #008000; font-weight: bold">/home/circleci/project/examples/minimal_benchmark/outputs/benchopt_run_2026-01</span>
71-
<span style="color: #008000; text-decoration-color: #008000; font-weight: bold">-08_13h00m31.parquet</span>
71+
<span style="color: #008000; text-decoration-color: #008000; font-weight: bold">-12_09h33m59.parquet</span>
7272
Processing
7373
/home/circleci/project/examples/minimal_benchmark/outputs/benchopt_run_2026-01
74-
-08_13h00m31.parquet
74+
-12_09h33m59.parquet
7575

7676

7777
</pre></div>
@@ -119,10 +119,10 @@ To get a more precise curve, you can increase ``n`` and ``r``:
119119
<span style="color: #000080; text-decoration-color: #000080; font-weight: bold"> |--gd[lr=0.01]:</span> <span style="color: #008000; text-decoration-color: #008000; font-weight: bold">done</span>
120120
<span style="color: #008000; text-decoration-color: #008000; font-weight: bold">Saving result in: </span>
121121
<span style="color: #008000; text-decoration-color: #008000; font-weight: bold">/home/circleci/project/examples/minimal_benchmark/outputs/benchopt_run_2026-01</span>
122-
<span style="color: #008000; text-decoration-color: #008000; font-weight: bold">-08_13h00m34.parquet</span>
122+
<span style="color: #008000; text-decoration-color: #008000; font-weight: bold">-12_09h34m03.parquet</span>
123123
Processing
124124
/home/circleci/project/examples/minimal_benchmark/outputs/benchopt_run_2026-01
125-
-08_13h00m34.parquet
125+
-12_09h34m03.parquet
126126

127127

128128
</pre></div>
@@ -151,7 +151,7 @@ suboptimality instead of objective value.
151151

152152
.. rst-class:: sphx-glr-timing
153153

154-
**Total running time of the script:** (0 minutes 4.138 seconds)
154+
**Total running time of the script:** (0 minutes 4.910 seconds)
155155

156156

157157
.. _sphx_glr_download_auto_examples_run_minimal_benchmark.py:

dev/_sources/auto_examples/sg_execution_times.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Computation times
88
=================
9-
**00:04.138** total execution time for 3 files **from auto_examples**:
9+
**00:04.910** total execution time for 3 files **from auto_examples**:
1010

1111
.. container::
1212

@@ -33,7 +33,7 @@ Computation times
3333
- Time
3434
- Mem (MB)
3535
* - :ref:`sphx_glr_auto_examples_run_minimal_benchmark.py` (``run_minimal_benchmark.py``)
36-
- 00:04.138
36+
- 00:04.910
3737
- 0.0
3838
* - :ref:`sphx_glr_auto_examples_plot_run_benchmark.py` (``plot_run_benchmark.py``)
3939
- 00:00.000

dev/_sources/benchmark_workflow/manage_benchmark_results.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ The DataFrame contains the following columns:
2121
components used for this line.
2222
- ``obj_description|solver_description``: A more verbose description of the
2323
objective and solver, displayed in the HTML page.
24+
- ``file_objective|file_solver|file_dataset``: The filename of the objective,
25+
solver, and dataset used for this line.
2426
- ``p_obj_p``: the value of the objective's parameter ``p``.
2527
- ``p_solver_p``: the value of the solver's parameter ``p``.
2628
- ``p_dateset_p``: the value of the dataset's parameter ``p``.

dev/_sources/sg_execution_times.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Computation times
88
=================
9-
**00:04.138** total execution time for 3 files **from all galleries**:
9+
**00:04.910** total execution time for 3 files **from all galleries**:
1010

1111
.. container::
1212

@@ -33,7 +33,7 @@ Computation times
3333
- Time
3434
- Mem (MB)
3535
* - :ref:`sphx_glr_auto_examples_run_minimal_benchmark.py` (``../examples/run_minimal_benchmark.py``)
36-
- 00:04.138
36+
- 00:04.910
3737
- 0.0
3838
* - :ref:`sphx_glr_auto_examples_plot_run_benchmark.py` (``../examples/plot_run_benchmark.py``)
3939
- 00:00.000

dev/_sources/whats_new.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ API
4545
- Allow to override SLURM config on a per run basis with ``Solver.parameters``
4646
See :ref:`slurm_override`. By `Geraud Ilinca`_ and `Thomas Moreau`_ (:gh:`848`)
4747

48+
- Add filename metadata in the result parquet files for
49+
objective, solver, and dataset. By `Thomas Moreau`_ (:gh:`873`)
50+
4851
DOC
4952
---
5053

0 commit comments

Comments
 (0)