Skip to content

Commit ddaabbc

Browse files
authored
Merge pull request #189 from fabinsch/update-doc-windows-pip
doc: pip install available on windows
2 parents f44b936 + a011a5b commit ddaabbc

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,18 @@ We are ready to integrate **ProxSuite** within other optimization ecosystems.
2727
**Proxsuite** is fast:
2828

2929
- C++ template library,
30-
- cache friendly.
30+
- cache-friendly.
3131

3232
**Proxsuite** is versatile, offering through a unified API advanced algorithms specialized for efficiently exploiting problem structures:
3333

34-
- dense, sparse and matrix free matrix factorization backends,
34+
- dense, sparse and matrix-free matrix factorization backends,
3535
- advanced warm-starting options (e.g., equality-constrained initial guess, warm-start or cold-start options from previous results).
3636

3737
**Proxsuite** is flexible:
3838

3939
- header only,
4040
- C++ 14/17/20 compliant,
41-
- Python and Julia bindings for easy code prototyping without sacrificing performances.
41+
- Python and Julia bindings for easy code prototyping without sacrificing performance.
4242

4343
**Proxsuite** is extensible.
4444
**Proxsuite** is reliable and extensively tested, showing the best performances on the hardest problems of the literature.
@@ -57,7 +57,7 @@ The online **ProxSuite** documentation of the last release is available [here](h
5757
```bash
5858
pip install proxsuite
5959
```
60-
This approach is only available on Linux and Mac OS X.
60+
This approach is available on Linux, Windows and Mac OS X.
6161

6262
### Quick install with <img src="https://s3.amazonaws.com/conda-dev/conda_logo.svg" height="18">:
6363

@@ -124,21 +124,21 @@ If you are using **ProxQP** for your work, we encourage you to [cite the related
124124

125125
The numerical benchmarks of **ProxQP** against other commercial and open-source solvers are available [here](https://github.com/Simple-Robotics/proxqp_benchmark).
126126

127-
For dense Convex Quadratic Programs with inequality and equality constraints, when asking for a relatively high accuracy (e.g., 1e-6), one obtains the following results.
127+
For dense Convex Quadratic Programs with inequality and equality constraints, when asking for relatively high accuracy (e.g., 1e-6), one obtains the following results.
128128

129129
<p align="center">
130130
<img src="https://github.com/Simple-Robotics/proxsuite/raw/main/doc/images/time_series_barplot_Random Mixed QP_dense_eps_abs_1e-6.jpg" width="600" alt="Random Mixed QP_dense_eps_abs_1e-6" align="center"/>
131131
</p>
132132

133-
On the y-axis you can see timings in seconds, and on the x-axis dimension wrt to the primal variable of the random Quadratic problems generated (the number of constraints of the generated problem is half the size of its primal dimension). For every dimension, the problem is generated over different seeds and timings are obtained as averages over successive runs for the same problems. This chart shows for every benchmarked solvers and random Quadratic programs generated, barplots timings including median (as a dot) and minimal and maximal values obtained (defining the amplitude of the bar). You can see that **ProxQP** is always below over solvers, which means it is the quickest for this test.
133+
On the y-axis, you can see timings in seconds, and on the x-axis dimension wrt to the primal variable of the random Quadratic problems generated (the number of constraints of the generated problem is half the size of its primal dimension). For every dimension, the problem is generated over different seeds and timings are obtained as averages over successive runs for the same problems. This chart shows for every benchmarked solver and random Quadratic program generated, barplot timings including median (as a dot) and minimal and maximal values obtained (defining the amplitude of the bar). You can see that **ProxQP** is always below over solvers, which means it is the quickest for this test.
134134

135-
For hard problems from the [Maros Meszaros testset](http://www.cuter.rl.ac.uk/Problems/marmes.shtml), when asking for a high accuracy (e.g., 1e-9), one obtains the results below.
135+
For hard problems from the [Maros Meszaros testset](http://www.cuter.rl.ac.uk/Problems/marmes.shtml), when asking for high accuracy (e.g., 1e-9), one obtains the results below.
136136

137137
<p align="center">
138138
<img src="https://github.com/Simple-Robotics/proxsuite/raw/main/doc/images/performance_profile_maros_meszaros_problems_high_accuracy.jpg" width="600" alt="maros_meszaros_problems_high_accuracy" align="center"/>
139139
</p>
140140

141-
This chart above reports performance profiles of different solvers. It is classic for benchmarking solvers. Performance profiles correspond to the fraction of problems solved (on y-axis) as a function of certain runtime (on x-axis, measured in terms of a multiple of the runtime of the fastest solver for that problem). So the higher on the chart the better. You can see that **ProxQP** solves the quickest over 60% of the problems (i.e., for $\tau=1$), and that for solving about 90% of the problems, it is at most 2 times slower than the fastest solvers solving these problems (i.e., for $\tau\approx2$).
141+
The chart above reports the performance profiles of different solvers. It is classic for benchmarking solvers. Performance profiles correspond to the fraction of problems solved (on y-axis) as a function of certain runtime (on x-axis, measured in terms of a multiple of the runtime of the fastest solver for that problem). So the higher on the chart the better. You can see that **ProxQP** solves the quickest over 60% of the problems (i.e., for $\tau=1$), and that for solving about 90% of the problems, it is at most 2 times slower than the fastest solvers solving these problems (i.e., for $\tau\approx2$).
142142

143143
*Note: All these results have been obtained with a 11th Gen Intel(R) Core(TM) i7-11850H @ 2.50GHz CPU.*
144144

0 commit comments

Comments
 (0)