From a011a5b70533f9052fa32ea19c2a4613b2c8bed7 Mon Sep 17 00:00:00 2001 From: Fabian Schramm <55981657+fabinsch@users.noreply.github.com> Date: Thu, 2 Mar 2023 09:51:27 +0100 Subject: [PATCH] doc: pip install available on windows --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2a209b60e..e90ada191 100644 --- a/README.md +++ b/README.md @@ -27,18 +27,18 @@ We are ready to integrate **ProxSuite** within other optimization ecosystems. **Proxsuite** is fast: - C++ template library, - - cache friendly. + - cache-friendly. **Proxsuite** is versatile, offering through a unified API advanced algorithms specialized for efficiently exploiting problem structures: - - dense, sparse and matrix free matrix factorization backends, + - dense, sparse and matrix-free matrix factorization backends, - advanced warm-starting options (e.g., equality-constrained initial guess, warm-start or cold-start options from previous results). **Proxsuite** is flexible: - header only, - C++ 14/17/20 compliant, - - Python and Julia bindings for easy code prototyping without sacrificing performances. + - Python and Julia bindings for easy code prototyping without sacrificing performance. **Proxsuite** is extensible. **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 ```bash pip install proxsuite ``` -This approach is only available on Linux and Mac OS X. +This approach is available on Linux, Windows and Mac OS X. ### Quick install with : @@ -124,21 +124,21 @@ If you are using **ProxQP** for your work, we encourage you to [cite the related The numerical benchmarks of **ProxQP** against other commercial and open-source solvers are available [here](https://github.com/Simple-Robotics/proxqp_benchmark). -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. +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.

Random Mixed QP_dense_eps_abs_1e-6

-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. +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. -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. +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.

maros_meszaros_problems_high_accuracy

-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$). +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$). *Note: All these results have been obtained with a 11th Gen Intel(R) Core(TM) i7-11850H @ 2.50GHz CPU.*