-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathwhats_new.html
966 lines (830 loc) · 73.9 KB
/
whats_new.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>What’s new — benchopt 1.6.1.dev20 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/vendor/fontawesome/6.5.2/css/all.min.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d6e0657c" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
<script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
<script src="_static/documentation_options.js?v=57f4f5fb"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=30646c52"></script>
<script src="_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'whats_new';</script>
<link rel="icon" href="_static/logo_benchopt.png"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="How to contribute" href="contrib.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<input type="checkbox"
class="sidebar-toggle"
id="pst-primary-sidebar-checkbox"/>
<label class="overlay overlay-primary" for="pst-primary-sidebar-checkbox"></label>
<input type="checkbox"
class="sidebar-toggle"
id="pst-secondary-sidebar-checkbox"/>
<label class="overlay overlay-secondary" for="pst-secondary-sidebar-checkbox"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search..."
aria-label="Search..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/logo_benchopt.png" class="logo__image only-light" alt="benchopt logo"/>
<script>document.write(`<img src="_static/logo_benchopt.png" class="logo__image only-dark" alt="benchopt logo"/>`);</script>
<p class="title logo__title">1.6.1.dev20</p>
</a></div>
<div class="sidebar-primary-item">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search..."
aria-label="Search..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<ul class="nav bd-sidenav bd-sidenav__home-link">
<li class="toctree-l1">
<a class="reference internal" href="index.html">
Benchopt
</a>
</li>
</ul>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="get_started.html">Get started</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="benchmark_workflow/index.html">Benchmark workflow</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="benchmark_workflow/run_benchmark.html">Run a benchmark</a></li>
<li class="toctree-l2"><a class="reference internal" href="benchmark_workflow/write_benchmark.html">Write a benchmark</a></li>
<li class="toctree-l2"><a class="reference internal" href="benchmark_workflow/visualize_benchmark.html">Visualize a benchmark</a></li>
<li class="toctree-l2"><a class="reference internal" href="benchmark_workflow/manage_benchmark_results.html">Manage benchmark results</a></li>
<li class="toctree-l2"><a class="reference internal" href="benchmark_workflow/config_benchopt.html">Configure Benchopt</a></li>
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="tutorials/index.html">Tutorials</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials/build_benchmark.html">Understanding and building a simple benchmark</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/add_solver.html">Add a solver to an existing benchmark</a></li>
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="user_guide/index.html">User guide</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="user_guide/API_ref.html">API references</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="user_guide/generated/benchopt.BaseObjective.html">benchopt.BaseObjective</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/generated/benchopt.BaseDataset.html">benchopt.BaseDataset</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/generated/benchopt.BaseSolver.html">benchopt.BaseSolver</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/generated/benchopt.run_benchmark.html">benchopt.run_benchmark</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/generated/benchopt.safe_import_context.html">benchopt.safe_import_context</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/generated/benchopt.plotting.plot_benchmark.html">benchopt.plotting.plot_benchmark</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/generated/benchopt.datasets.simulated.make_correlated_data.html">benchopt.datasets.simulated.make_correlated_data</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide/generated/benchopt.utils.profile.html">benchopt.utils.profile</a></li>
</ul>
</details></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/CLI_ref.html">Command line interface (CLI) references</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/advanced.html">Advanced usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/ml_benchmark.html">Setting up an ML benchmark</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/performance_curves.html">Performance curves</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/tweak_datasets.html">Tweak a dataset</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="available_benchmarks.html">Available benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="contrib.html">How to contribute</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">What’s new</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="sbt-scroll-pixel-helper"></div>
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item"><button class="sidebar-toggle primary-toggle btn btn-sm" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-bars"></span>
</button></div>
</div>
<div class="header-article-items__end">
<div class="header-article-item">
<div class="article-header-buttons">
<a href="https://github.com/benchopt/benchopt" target="_blank"
class="btn btn-sm btn-source-repository-button"
title="Source repository"
data-bs-placement="bottom" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fab fa-github"></i>
</span>
</a>
<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script>
<script>
document.write(`
<button class="btn btn-sm pst-navbar-icon search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
`);
</script>
<button class="sidebar-toggle secondary-toggle btn btn-sm" title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-list"></span>
</button>
</div></div>
</div>
</div>
</div>
<div id="jb-print-docs-body" class="onlyprint">
<h1>What’s new</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
<div>
<h2> Contents </h2>
</div>
<nav aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-7-in-development">Version 1.7 - in development</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#major-change">Major change</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#cli">CLI</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#api">API</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#fix">FIX</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-6-15-07-2024">Version 1.6 - 15/07/2024</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id1">API</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id2">CLI</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id3">FIX</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#doc">DOC</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-5-1-22-09-2023">Version 1.5.1 - 22/09/2023</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id4">FIX</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-5-18-09-2023">Version 1.5 - 18/09/2023</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id5">API</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#plot">PLOT</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id6">DOC</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#internals">Internals</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-4-03-07-2023">Version 1.4 - 03/07/2023</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id7">CLI</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id8">API</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id9">PLOT</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id10">FIX</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-3-1-01-12-2022">Version 1.3.1 - 01/12/2022</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id11">FIX</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-3-21-11-2022">Version 1.3 - 21/11/2022</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id12">CLI</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id13">API</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-2-06-05-2022">Version 1.2 - 06/05/2022</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#changelog">Changelog</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id14">API</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id15">CLI</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-1-22-04-2021">Version 1.1 - 22-04-2021</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id16">Changelog</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id17">API</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id18">CLI</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#bug">BUG</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id19">DOC</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-0-2020-09-25">Version 1.0 - 2020-09-25</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#release-highlights">Release highlights</a></li>
</ul>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="what-s-new">
<span id="whats-new"></span><h1>What’s new<a class="headerlink" href="#what-s-new" title="Link to this heading">#</a></h1>
<section id="version-1-7-in-development">
<span id="changes-1-7"></span><h2>Version 1.7 - in development<a class="headerlink" href="#version-1-7-in-development" title="Link to this heading">#</a></h2>
</section>
<section id="major-change">
<h2>Major change<a class="headerlink" href="#major-change" title="Link to this heading">#</a></h2>
<ul class="simple">
<li><p>Benchopt is now supported on Windows!! \o/
By <a class="reference external" href="https://wassimmazouz.github.io/">Wassim Mazouz</a>, <a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a> and <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/717">#717</a>)</p></li>
</ul>
</section>
<section id="cli">
<h2>CLI<a class="headerlink" href="#cli" title="Link to this heading">#</a></h2>
<ul class="simple">
<li><p>Add <code class="docutils literal notranslate"><span class="pre">--gpu</span></code> flag to <code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">install</span></code>, to handle different requirements
for GPU and CPU. By <a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/793">#793</a>)</p></li>
</ul>
</section>
<section id="api">
<h2>API<a class="headerlink" href="#api" title="Link to this heading">#</a></h2>
<ul class="simple">
<li><p>Support <code class="docutils literal notranslate"><span class="pre">requirements</span></code> being a dictionary with keys <code class="docutils literal notranslate"><span class="pre">"gpu"</span></code> and <code class="docutils literal notranslate"><span class="pre">"cpu"</span></code>, for
classes whose install differ on GPU and CPU.
By <a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/793">#793</a>)</p></li>
<li><p>Change channel specification in requirements, replacing the split format
with <code class="docutils literal notranslate"><span class="pre">::</span></code> instead of <code class="docutils literal notranslate"><span class="pre">:</span></code>. This allow specifying URL channels.
By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/758">#758</a>)</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">Objective</span></code>, <code class="docutils literal notranslate"><span class="pre">Solver</span></code> and <code class="docutils literal notranslate"><span class="pre">Dataset</span></code> parameters as columns in the
result DataFrame. The parameters’ names are respectively prefixed with
<code class="docutils literal notranslate"><span class="pre">p_obj_|p_solver_|p_dataset_</span></code> to avoid collapse between the different
components. By <a class="reference external" href="https://github.com/Melvin-klein">Melvine Nargeot</a> and <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/703">#703</a>).</p></li>
</ul>
</section>
<section id="fix">
<h2>FIX<a class="headerlink" href="#fix" title="Link to this heading">#</a></h2>
<ul class="simple">
<li><p>Display for boxplot in the <code class="docutils literal notranslate"><span class="pre">result.js</span></code> was broken.
By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/757">#757</a>)</p></li>
<li><p>Default value for <code class="docutils literal notranslate"><span class="pre">data_home</span></code> was incorrect.
By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/758">#758</a>)</p></li>
<li><p>Fix the <code class="docutils literal notranslate"><span class="pre">skip</span></code> API for objectives that was leading to a display error.
By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/763">#763</a>)</p></li>
<li><p>Fix the <code class="docutils literal notranslate"><span class="pre">info</span></code> command. By <a class="reference external" href="https://github.com/paquiteau">Pierre-Antoine Comby</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/768">#768</a>)</p></li>
</ul>
</section>
<section id="version-1-6-15-07-2024">
<span id="changes-1-6"></span><h2>Version 1.6 - 15/07/2024<a class="headerlink" href="#version-1-6-15-07-2024" title="Link to this heading">#</a></h2>
<section id="id1">
<h3>API<a class="headerlink" href="#id1" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Add a <code class="docutils literal notranslate"><span class="pre">save_final_results</span></code> method to Objective. If implemented it is run
after the last solver iteration, to get desired outputs to be saved to file
system. By <a class="reference external" href="https://github.com/paquiteau">Pierre-Antoine Comby</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/722">#722</a>)</p></li>
<li><p>Add native way to do cross-validation in a benchmark with
<code class="docutils literal notranslate"><span class="pre">Objective.cv</span></code> attribute that change split for each repetition.
By <a class="reference external" href="https://github.com/chris-mrn">Christopher Marouani</a> and <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/623">#623</a>).</p></li>
<li><p>Run-config files now support having parameters as nested dict, with
potentially non-trivial structures (like dictionaries).
By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/706">#706</a>).</p></li>
<li><p>Raise error when an invalid install_cmd is provided.
By <a class="reference external" href="https://github.com/Jad-yehya">Jad Yehya</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/714">#714</a>).</p></li>
<li><p>Add boxplot option to plot the benchmark results.
By <a class="reference external" href="https://github.com/Melvin-klein">Melvine Nargeot</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/714">#714</a>).</p></li>
</ul>
</section>
<section id="id2">
<h3>CLI<a class="headerlink" href="#id2" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Add <code class="docutils literal notranslate"><span class="pre">--collect</span></code> option to allow gathering results which are already
in cache in a single parquet file. By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/710">#710</a>)</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">--download</span></code> option in <code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">install</span></code> to allow downloading
the data when installing the benchmark. By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/718">#718</a>)</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">--no-timeout</span></code> option in <code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">run</span></code> to allow solvers to bypass
timeout. By <a class="reference external" href="https://github.com/ceelestin">Célestin Eve</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/725">#725</a>)</p></li>
<li><p>Remove support for deprecated <code class="docutils literal notranslate"><span class="pre">.ini</span></code> config files. All config files should
now use the <code class="docutils literal notranslate"><span class="pre">yaml</span></code> format. By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/699">#699</a>)</p></li>
</ul>
</section>
<section id="id3">
<h3>FIX<a class="headerlink" href="#id3" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Disable caching of diverged/errored runs. By <a class="reference external" href="https://www.linkedin.com/in/julie-alberge">Julie Alberge</a> and
<a class="reference external" href="https://www.linkedin.com/in/virginie-loison/">Virginie Loison</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/735">#735</a>)</p></li>
<li><p>Fix pickling of dynamic modules to allow for nested parallelism in
distributed runs. By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/713">#713</a>)</p></li>
</ul>
</section>
<section id="doc">
<h3>DOC<a class="headerlink" href="#doc" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Add documentation for the <code class="docutils literal notranslate"><span class="pre">run_once</span></code> sampling strategy.
By <a class="reference external" href="https://matdag.github.io">Mathieu Dagréou</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/700">#700</a>).</p></li>
</ul>
</section>
</section>
<section id="version-1-5-1-22-09-2023">
<span id="changes-1-5-1"></span><h2>Version 1.5.1 - 22/09/2023<a class="headerlink" href="#version-1-5-1-22-09-2023" title="Link to this heading">#</a></h2>
<p>Bugfix release.</p>
<section id="id4">
<h3>FIX<a class="headerlink" href="#id4" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Fix benchopt dependency specification to install benchopt in child env
with extra <code class="docutils literal notranslate"><span class="pre">[test]</span></code>. By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/662">#662</a>).</p></li>
</ul>
</section>
</section>
<section id="version-1-5-18-09-2023">
<span id="changes-1-5"></span><h2>Version 1.5 - 18/09/2023<a class="headerlink" href="#version-1-5-18-09-2023" title="Link to this heading">#</a></h2>
<section id="id5">
<h3>API<a class="headerlink" href="#id5" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Add a <code class="docutils literal notranslate"><span class="pre">Objective.url</span></code> attribute to specify the original repo of the
benchmark. By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/621">#621</a>).</p></li>
<li><p>Deprecate passing in arguments to callback of when <code class="docutils literal notranslate"><span class="pre">sampling_strategy='callback'</span></code>.
Now on, the results from the <code class="docutils literal notranslate"><span class="pre">Solver</span></code> are collected using <code class="docutils literal notranslate"><span class="pre">get_result</span></code>.
By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/631">#631</a>).</p></li>
<li><p>Deprecate <code class="docutils literal notranslate"><span class="pre">Objective.get_one_solution</span></code> in favor of <code class="docutils literal notranslate"><span class="pre">Objective.get_one_result</span></code>
for consistency with <code class="docutils literal notranslate"><span class="pre">Objective.evaluate_result</span></code>.
By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/631">#631</a>).</p></li>
<li><p>Deprecate <code class="docutils literal notranslate"><span class="pre">Objective.compute</span></code> in favor of <code class="docutils literal notranslate"><span class="pre">Objective.evaluate_result</span></code>, for
consistency with <code class="docutils literal notranslate"><span class="pre">Solver.get_result</span></code>. Like <code class="docutils literal notranslate"><span class="pre">Dataset.get_data</span></code>,
<code class="docutils literal notranslate"><span class="pre">Solver.get_result</span></code> must now return a dictionary, which is unpacked as
arguments to <code class="docutils literal notranslate"><span class="pre">Objective.evaluate_result</span></code>.
By <a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/576">#576</a>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Solver.support_sparse</span></code> attribute is deprecated in favor of the use of
<code class="docutils literal notranslate"><span class="pre">Solver.skip</span></code>, by <a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/614">#614</a>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">stopping_strategy</span></code> attribute is replaced by <code class="docutils literal notranslate"><span class="pre">sampling_strategy</span></code> to clarify
the concept, by <a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/585">#585</a>).</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">Solver.warm_up</span></code> function for explicit warmup instructions, such as
empty run for jitting. This function is called only once per solver.
By <a class="reference external" href="https://github.com/pierreablin">Pierre Ablin</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/602">#602</a>).</p></li>
</ul>
</section>
<section id="plot">
<h3>PLOT<a class="headerlink" href="#plot" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Add the possibility to save views of the plot in the HTML. These views can be
created in the HTML interface and saved in config files, linked to output
parquet files, by <a class="reference external" href="https://github.com/AmelieVernay">Amélie Vernay</a>, <a class="reference external" href="https://github.com/tanglef">Tanguy Lefort</a>, <a class="reference external" href="https://github.com/Melvin-klein">Melvine Nargeot</a>
and <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/552">#552</a>).</p></li>
</ul>
</section>
<section id="id6">
<h3>DOC<a class="headerlink" href="#id6" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Reformatting and enriching the documentation for easy onboarding.
By <a class="reference external" href="https://github.com/Badr-MOUFAD">Badr Moufad</a> and <a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/619">#619</a>, <a class="reference external" href="https://github.com/benchopt/benchopt/pull/629">#629</a>).</p></li>
<li><p>Tutorial on adding a new solver to a benchmark.
By <a class="reference external" href="https://github.com/Badr-MOUFAD">Badr MOUFAD</a> and <a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/635">#635</a>).</p></li>
</ul>
</section>
<section id="internals">
<h3>Internals<a class="headerlink" href="#internals" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Add helper to store and retrieve metadata in parquet files. This will
allow storing per-run plotting information.
By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/637">#637</a>).</p></li>
</ul>
</section>
</section>
<section id="version-1-4-03-07-2023">
<span id="changes-1-4"></span><h2>Version 1.4 - 03/07/2023<a class="headerlink" href="#version-1-4-03-07-2023" title="Link to this heading">#</a></h2>
<section id="id7">
<h3>CLI<a class="headerlink" href="#id7" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Add support for minute and hour unit suffix in timeout limit through the syntax
<code class="docutils literal notranslate"><span class="pre">--timeout</span> <span class="pre">10m</span></code> or <code class="docutils literal notranslate"><span class="pre">--timeout</span> <span class="pre">1h</span></code>.
By <a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/535">#535</a>).</p></li>
<li><p>Remove deprecated <code class="docutils literal notranslate"><span class="pre">-o/--objective-filter</span></code> option in <code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">run</span></code>.
By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/569">#569</a>)</p></li>
<li><p>Deprecate <code class="docutils literal notranslate"><span class="pre">.ini</span></code> config file and use <code class="docutils literal notranslate"><span class="pre">.yml</span></code> files instead. A conversion
should be performed automatically.
By <a class="reference external" href="https://github.com/tanglef">Tanguy Lefort</a>, <a class="reference external" href="https://github.com/AmelieVernay">Amélie Vernay</a> and <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/552">#552</a>).</p></li>
</ul>
</section>
<section id="id8">
<h3>API<a class="headerlink" href="#id8" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>The <code class="docutils literal notranslate"><span class="pre">get_next</span></code> method of <a class="reference internal" href="user_guide/generated/benchopt.BaseSolver.html#benchopt.BaseSolver" title="benchopt.BaseSolver"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseSolver</span></code></a> is no longer static.
By <a class="reference external" href="https://github.com/Badr-MOUFAD">Badr Moufad</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/566">#566</a>)</p></li>
<li><p>Add <code class="xref py py-class docutils literal notranslate"><span class="pre">SingleRunCriterion</span></code> to run a solver
only once. This can be used for benchmarking methods where we are interested
in objective value at convergence. By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/511">#511</a>)</p></li>
<li><p>Add <a class="reference internal" href="user_guide/generated/benchopt.BaseSolver.html#benchopt.BaseSolver.run_once" title="benchopt.BaseSolver.run_once"><code class="xref py py-func docutils literal notranslate"><span class="pre">run_once()</span></code></a> helper to easily warmup solvers
with callback. By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/511">#511</a>)</p></li>
<li><p>Add <a class="reference internal" href="user_guide/generated/benchopt.BaseSolver.html#benchopt.BaseSolver.pre_run_hook" title="benchopt.BaseSolver.pre_run_hook"><code class="xref py py-func docutils literal notranslate"><span class="pre">pre_run_hook()</span></code></a> hook to ignore cost that cannot
be cached globally for a solver. By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/525">#525</a>)</p></li>
<li><p>Remove deprecated <code class="docutils literal notranslate"><span class="pre">Objective.to_dict</span></code>, <code class="docutils literal notranslate"><span class="pre">safe_import_context.import_from</span></code>.
Force implementation of <code class="xref py py-meth docutils literal notranslate"><span class="pre">get_one_solution()</span></code>.
By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/569">#569</a>)</p></li>
</ul>
</section>
<section id="id9">
<h3>PLOT<a class="headerlink" href="#id9" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Add a tooltip beside to show description of objective. Description is provided as docstring of
the <a class="reference internal" href="user_guide/generated/benchopt.BaseObjective.html#benchopt.BaseObjective" title="benchopt.BaseObjective"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseObjective</span></code></a> class. By <a class="reference external" href="https://github.com/Badr-MOUFAD">Badr Moufad</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/556">#556</a>)</p></li>
<li><p>Show solver description when hovering over solvers. Description is provided as docstring of
the <a class="reference internal" href="user_guide/generated/benchopt.BaseSolver.html#benchopt.BaseSolver" title="benchopt.BaseSolver"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseSolver</span></code></a> class. By <a class="reference external" href="https://github.com/Badr-MOUFAD">Badr Moufad</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/543">#543</a>)</p></li>
<li><p>Enable visualizing the objective as function of <code class="docutils literal notranslate"><span class="pre">stopping_criterion</span></code>: time,
iteration, or tolerance. By <a class="reference external" href="https://github.com/Badr-MOUFAD">Badr Moufad</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/479">#479</a>)</p></li>
<li><p>Add button to share and set specific views on the plot. For now, the view needs
to be defined manually in the benchmark config file but an export button will
be added in follow up PRs.
By <a class="reference external" href="https://github.com/tanglef">Tanguy Lefort</a>, <a class="reference external" href="https://github.com/AmelieVernay">Amélie Vernay</a> and <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/552">#552</a>).</p></li>
</ul>
</section>
<section id="id10">
<h3>FIX<a class="headerlink" href="#id10" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Do not fail and raise a warning when <code class="docutils literal notranslate"><span class="pre">safe_import_context</span></code> is not named
<code class="docutils literal notranslate"><span class="pre">import_ctx</span></code>. By <a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/524">#524</a>)</p></li>
</ul>
</section>
</section>
<section id="version-1-3-1-01-12-2022">
<span id="changes-1-3-1"></span><h2>Version 1.3.1 - 01/12/2022<a class="headerlink" href="#version-1-3-1-01-12-2022" title="Link to this heading">#</a></h2>
<p>Bug fix release</p>
<section id="id11">
<h3>FIX<a class="headerlink" href="#id11" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Typo in README and doc</p></li>
<li><p>Barchart solver color to be the same as the other plots.</p></li>
<li><p>Warning for deprecation not using the right class</p></li>
<li><p>Plot quantile incorrect display</p></li>
</ul>
</section>
</section>
<section id="version-1-3-21-11-2022">
<span id="changes-1-3"></span><h2>Version 1.3 - 21/11/2022<a class="headerlink" href="#version-1-3-21-11-2022" title="Link to this heading">#</a></h2>
<section id="id12">
<h3>CLI<a class="headerlink" href="#id12" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Add support for custom parameters in CLI for objectives, datasets, and
solvers, through the syntax <code class="docutils literal notranslate"><span class="pre">-s</span> <span class="pre">solver_name[parameter=value]</span></code>. See the <a class="reference external" href="https://benchopt.github.io/cli.html">CLI
documentation</a> for more details on the
syntax. By <a class="reference external" href="https://tomdlt.github.io">Tom Dupré la Tour</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/362">#362</a>).</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">--slurm</span></code> option in <code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">run</span></code> to allow running the benchmark on
a SLURM cluster. See the <a class="reference internal" href="user_guide/advanced.html#slurm-run"><span class="std std-ref">Running the benchmark on a SLURM cluster</span></a> for more details on the config.
By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/407">#407</a>)</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">archive</span></code> to create a <code class="docutils literal notranslate"><span class="pre">tar.gz</span></code> archive with the benchmark’s
files for sharing with others or as supplementary materials for papers.
By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/408">#408</a>).</p></li>
<li><p>Now the result data are saved in the Parquet format. The use of CSV files is deprecated.
By <a class="reference external" href="https://github.com/Melvin-klein">Melvine Nargeot</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/433">#433</a>).</p></li>
<li><p>Change the default number of repetitions to <code class="docutils literal notranslate"><span class="pre">1</span></code>.
By <a class="reference external" href="https://github.com/bmalezieux">Benoît Malézieux</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/457">#457</a>).</p></li>
</ul>
</section>
<section id="id13">
<h3>API<a class="headerlink" href="#id13" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Allow changing tracked metric in <code class="docutils literal notranslate"><span class="pre">StoppingCriterion</span></code>.
By <a class="reference external" href="https://github.com/AmelieVernay">Amélie Vernay</a> and <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/461">#461</a>).</p></li>
<li><p>Add latest git tag via <code class="docutils literal notranslate"><span class="pre">benchmark-git-tag</span></code> key in <code class="xref py py-func docutils literal notranslate"><span class="pre">benchopt.utils.sys_info.get_sys_info()</span></code>.
By <a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/421">#421</a>).</p></li>
<li><p>Deprecate <code class="docutils literal notranslate"><span class="pre">Objective.to_dict</span></code> in favor of <a class="reference internal" href="user_guide/generated/benchopt.BaseObjective.html#benchopt.BaseObjective.get_objective" title="benchopt.BaseObjective.get_objective"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_objective()</span></code></a>.
By <a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/489">#489</a>).</p></li>
<li><p>Deprecate <code class="docutils literal notranslate"><span class="pre">import_from</span></code> in favor of a <code class="docutils literal notranslate"><span class="pre">benchmark_utils</span></code> module dynamically installed
when running a benchmark. By <a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a> and <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/472">#472</a>).</p></li>
<li><p>Allow specifying channels for conda requirements with syntax <code class="docutils literal notranslate"><span class="pre">chan:deps</span></code>.
By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/483">#483</a>).</p></li>
<li><p>Allow for template <code class="docutils literal notranslate"><span class="pre">Solver</span></code> and <code class="docutils literal notranslate"><span class="pre">Dataset</span></code> in <code class="docutils literal notranslate"><span class="pre">datasets</span></code>/ <code class="docutils literal notranslate"><span class="pre">solvers</span></code> directory.
By <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/473">#473</a>).</p></li>
</ul>
</section>
</section>
<section id="version-1-2-06-05-2022">
<span id="changes-1-2"></span><h2>Version 1.2 - 06/05/2022<a class="headerlink" href="#version-1-2-06-05-2022" title="Link to this heading">#</a></h2>
<section id="changelog">
<h3>Changelog<a class="headerlink" href="#changelog" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>New <code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">info</span></code> command to display information about solvers and datasets
of a benchmark, by <a class="reference external" href="https://gdurif.perso.math.cnrs.fr/">Ghislain Durif</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/140">#140</a>).</p></li>
<li><p>New <code class="docutils literal notranslate"><span class="pre">--profile</span></code> option to the <code class="docutils literal notranslate"><span class="pre">run</span></code> command in order to profile
with the line-profiler package all functions decorated with
<a class="reference internal" href="user_guide/generated/benchopt.utils.profile.html#benchopt.utils.profile" title="benchopt.utils.profile"><code class="xref py py-func docutils literal notranslate"><span class="pre">benchopt.utils.profile()</span></code></a>, by <a class="reference external" href="http://alexandre.gramfort.net">Alexandre Gramfort</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/186">#186</a>).</p></li>
<li><p>Replace <code class="docutils literal notranslate"><span class="pre">SufficientDescentCriterion</span></code> by <code class="docutils literal notranslate"><span class="pre">SufficientProgressCriterion</span></code>,
which measures progress relative to the best attained value instead of
the previous one, by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/176">#176</a>)</p></li>
<li><p>Now all values returned by <code class="docutils literal notranslate"><span class="pre">Objective.compute</span></code> are included in reports,
by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> and <a class="reference external" href="http://alexandre.gramfort.net">Alexandre Gramfort</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/200">#200</a>).</p></li>
<li><p>New <code class="docutils literal notranslate"><span class="pre">--n-jobs,</span> <span class="pre">-j</span></code> option to run the benchmark in parallel with
<code class="docutils literal notranslate"><span class="pre">joblib</span></code>, by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/265">#265</a>).</p></li>
</ul>
</section>
<section id="id14">
<h3>API<a class="headerlink" href="#id14" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>When returning a dictionary, <code class="docutils literal notranslate"><span class="pre">Objective.compute</span></code> should at least include
<code class="docutils literal notranslate"><span class="pre">value</span></code> key instead of <code class="docutils literal notranslate"><span class="pre">objective_value</span></code>, by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> and
<a class="reference external" href="http://alexandre.gramfort.net">Alexandre Gramfort</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/200">#200</a>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">stop_strategy</span></code> attribute is replaced by <code class="docutils literal notranslate"><span class="pre">stopping_strategy</span></code> to harmonize
with <code class="docutils literal notranslate"><span class="pre">stopping_criterion</span></code>, by <a class="reference external" href="https://github.com/bmalezieux">Benoît Malézieux</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/274">#274</a>).</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">import_from</span></code> method in <code class="docutils literal notranslate"><span class="pre">safe_import_context</span></code> to allow importing common
files and packages without installation from <cite>BENCHMARK_DIR/utils</cite>,
by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/286">#286</a>).</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">X_density</span></code> argument to <code class="docutils literal notranslate"><span class="pre">datasets.make_correlated_data</span></code> to simulate
sparse design matrices, by <a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/289">#289</a>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Dataset.get_data</span></code> should now return a dictionary and not a tuple. A point for
testing should be returned by a dedicated method
<code class="docutils literal notranslate"><span class="pre">Objective.get_one_solution</span></code>, by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/345">#345</a>).</p></li>
</ul>
</section>
<section id="id15">
<h3>CLI<a class="headerlink" href="#id15" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Replace <code class="docutils literal notranslate"><span class="pre">-p</span></code> flag by <code class="docutils literal notranslate"><span class="pre">-o</span></code> for Objective, by <a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/281">#281</a>).</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">--config</span></code> option to support passing argument with a <code class="docutils literal notranslate"><span class="pre">yaml</span></code>
config file, by <a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/325">#325</a>).</p></li>
</ul>
</section>
</section>
<section id="version-1-1-22-04-2021">
<span id="changes-1-1"></span><h2>Version 1.1 - 22-04-2021<a class="headerlink" href="#version-1-1-22-04-2021" title="Link to this heading">#</a></h2>
<section id="id16">
<h3>Changelog<a class="headerlink" href="#id16" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>New plotting functions with different optimality criteria,
by <a class="reference external" href="https://ngazagna.github.io">Nidham Gazagnadou</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/96">#96</a>).</p></li>
<li><p>Support Plotly for plotting functions, by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a>,
<a class="reference external" href="https://github.com/tanglef">Tanguy Lefort</a> and <a class="reference external" href="http://josephsalmon.eu">Joseph Salmon</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/110">#110</a>, <a class="reference external" href="https://github.com/benchopt/benchopt/pull/111">#111</a>, <a class="reference external" href="https://github.com/benchopt/benchopt/pull/112">#112</a>).</p></li>
<li><p>Change envrionment variable for config from <code class="docutils literal notranslate"><span class="pre">BENCHO_*</span></code> to <code class="docutils literal notranslate"><span class="pre">BENCHOPT_*</span></code>,
by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/128">#128</a>).</p></li>
<li><p>Add autocompletion support in the <code class="docutils literal notranslate"><span class="pre">benchopt</span></code> command,
by <a class="reference external" href="http://alexandre.gramfort.net">Alexandre Gramfort</a>, <a class="reference external" href="https://github.com/tanglef">Tanguy Lefort</a> and <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a>
(<a class="reference external" href="https://github.com/benchopt/benchopt/pull/133">#133</a>, <a class="reference external" href="https://github.com/benchopt/benchopt/pull/135">#135</a>).</p></li>
<li><p>Move most CI to GitHub action, with auto-release on PyPi,
by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/150">#150</a>, <a class="reference external" href="https://github.com/benchopt/benchopt/pull/154">#154</a>).</p></li>
<li><p>Remove <code class="docutils literal notranslate"><span class="pre">BENCHOPT_ALLOW_INSTALL</span></code> and always install to requested env as
the user now must request explicitly the install,
by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/155">#155</a>).</p></li>
</ul>
</section>
<section id="id17">
<h3>API<a class="headerlink" href="#id17" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">Objective.compute</span></code> can now return a dictionary with multiple outputs to
monitor several metrics at once, by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/84">#84</a>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Solver.skip</span></code> can now be used to skip objectives that are incompatible
for the Solver, by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/113">#113</a>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Solver</span></code> can now use <code class="docutils literal notranslate"><span class="pre">stop_strategy='callback'</span></code> to allow for
single call curve construction, by <a class="reference external" href="https://github.com/tanglef">Tanguy Lefort</a> and <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a>
(<a class="reference external" href="https://github.com/benchopt/benchopt/pull/137">#137</a>).</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">StoppingCriterion</span></code> to reliably and flexibly assess a solver convergence (cvg).
For now, only <code class="docutils literal notranslate"><span class="pre">SufficientDescentCriterion</span></code> is implemented but better
API to set criterion per benchmark should be implemented in a future release,
by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/151">#151</a>)</p></li>
</ul>
</section>
<section id="id18">
<h3>CLI<a class="headerlink" href="#id18" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Add <code class="docutils literal notranslate"><span class="pre">--version</span></code> option for <code class="docutils literal notranslate"><span class="pre">benchopt</span></code>, by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/83">#83</a>).</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">--pdb</span></code> option for <code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">run</span></code> to open debugger on error and help
benchmark debugging, by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/86">#86</a>).</p></li>
<li><p>Change default run to local mode. Can call a run in a dedicated env with
option <code class="docutils literal notranslate"><span class="pre">--env</span></code> or <code class="docutils literal notranslate"><span class="pre">--env-name</span> <span class="pre">ENV_NAME</span></code> to specify the env,
by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/94">#94</a>).</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">publish</span></code> command to push benchmark results to GitHub,
by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/110">#110</a>).</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">clean</span></code> command to remove cached files and output files locally,
by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/128">#128</a>).</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">config</span></code> command to allow easy configuration of <code class="docutils literal notranslate"><span class="pre">benchopt</span></code>
using the CLI, by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/128">#128</a>).</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">install</span></code> command to install benchmark requirements
(not done in <code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">run</span></code> anymore) by <a class="reference external" href="https://gdurif.perso.math.cnrs.fr/">Ghislain Durif</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/135">#135</a>).</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">info</span></code> command to print information about a benchmark
(including solvers, datasets, dependencies, etc.)
by <a class="reference external" href="https://gdurif.perso.math.cnrs.fr/">Ghislain Durif</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/140">#140</a>).</p></li>
</ul>
</section>
<section id="bug">
<h3>BUG<a class="headerlink" href="#bug" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Throw a warning when benchopt version in conda env does not match the one of
calling <code class="docutils literal notranslate"><span class="pre">benchopt</span></code>, by <a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/83">#83</a>).</p></li>
<li><p>Fix Lapack issue with R code, by <a class="reference external" href="https://github.com/tanglef">Tanguy Lefort</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/97">#97</a>).</p></li>
</ul>
</section>
<section id="id19">
<h3>DOC<a class="headerlink" href="#id19" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Improve how-to narrative documentation, by <a class="reference external" href="http://alexandre.gramfort.net">Alexandre Gramfort</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/93">#93</a>).</p></li>
<li><p>Add what’s new page, by <a class="reference external" href="http://alexandre.gramfort.net">Alexandre Gramfort</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/114">#114</a>).</p></li>
<li><p>Add documentation on how to publish results, by <a class="reference external" href="http://alexandre.gramfort.net">Alexandre Gramfort</a> (<a class="reference external" href="https://github.com/benchopt/benchopt/pull/118">#118</a>).</p></li>
</ul>
<p>The committer list for this release is the following:</p>
<blockquote>
<div><ul class="simple">
<li><p><a class="reference external" href="http://alexandre.gramfort.net">Alexandre Gramfort</a></p></li>
<li><p><a class="reference external" href="https://github.com/bmalezieux">Benoît Malézieux</a></p></li>
<li><p><a class="reference external" href="https://gdurif.perso.math.cnrs.fr/">Ghislain Durif</a></p></li>
<li><p><a class="reference external" href="http://josephsalmon.eu">Joseph Salmon</a></p></li>
<li><p><a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a></p></li>
<li><p><a class="reference external" href="https://ngazagna.github.io">Nidham Gazagnadou</a></p></li>
<li><p><a class="reference external" href="https://github.com/tanglef">Tanguy Lefort</a></p></li>
<li><p><a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a></p></li>
<li><p><a class="reference external" href="https://tomdlt.github.io">Tom Dupré la Tour</a></p></li>
</ul>
</div></blockquote>
</section>
</section>
<section id="version-1-0-2020-09-25">
<span id="changes-1-0"></span><h2>Version 1.0 - 2020-09-25<a class="headerlink" href="#version-1-0-2020-09-25" title="Link to this heading">#</a></h2>
<section id="release-highlights">
<h3>Release highlights<a class="headerlink" href="#release-highlights" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Provide a command line interface for benchmarking optimisation algorithm
implementations:</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">run</span></code> to run the benchmarks</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">plot</span></code> to display the results</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">benchopt</span> <span class="pre">test</span></code> to test that a benchmark folder is correctly structured.</p></li>
</ul>
</li>
</ul>
<p>The committer list for this release is the following:</p>
<blockquote>
<div><ul class="simple">
<li><p><a class="reference external" href="http://alexandre.gramfort.net">Alexandre Gramfort</a></p></li>
<li><p><a class="reference external" href="http://josephsalmon.eu">Joseph Salmon</a></p></li>
<li><p><a class="reference external" href="https://mathurinm.github.io">Mathurin Massias</a></p></li>
<li><p><a class="reference external" href="https://tommoral.github.io">Thomas Moreau</a></p></li>
<li><p><a class="reference external" href="https://tomdlt.github.io">Tom Dupré la Tour</a></p></li>
</ul>
</div></blockquote>
</section>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="contrib.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">How to contribute</p>
</div>
</a>
</div>
</footer>
</div>
<div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> Contents
</div>
<nav class="bd-toc-nav page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-7-in-development">Version 1.7 - in development</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#major-change">Major change</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#cli">CLI</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#api">API</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#fix">FIX</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-6-15-07-2024">Version 1.6 - 15/07/2024</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id1">API</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id2">CLI</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id3">FIX</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#doc">DOC</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-5-1-22-09-2023">Version 1.5.1 - 22/09/2023</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id4">FIX</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-5-18-09-2023">Version 1.5 - 18/09/2023</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id5">API</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#plot">PLOT</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id6">DOC</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#internals">Internals</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-4-03-07-2023">Version 1.4 - 03/07/2023</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id7">CLI</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id8">API</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id9">PLOT</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id10">FIX</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-3-1-01-12-2022">Version 1.3.1 - 01/12/2022</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id11">FIX</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-3-21-11-2022">Version 1.3 - 21/11/2022</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id12">CLI</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id13">API</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-2-06-05-2022">Version 1.2 - 06/05/2022</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#changelog">Changelog</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id14">API</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id15">CLI</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-1-22-04-2021">Version 1.1 - 22-04-2021</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id16">Changelog</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id17">API</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id18">CLI</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#bug">BUG</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id19">DOC</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#version-1-0-2020-09-25">Version 1.0 - 2020-09-25</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#release-highlights">Release highlights</a></li>
</ul>
</li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
<div class="bd-footer-content__inner container">
<div class="footer-item">
<p class="component-author">
By Benchopt contributors
</p>
</div>
<div class="footer-item">
<p class="copyright">
© Copyright 2020-2025.
<br/>
</p>
</div>
<div class="footer-item">
</div>
<div class="footer-item">
</div>
</div>
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b"></script>
<footer class="bd-footer">
</footer>
</body>
</html>