diff --git a/README.md b/README.md index be7d671..77dbc83 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,18 @@ +![Build status](https://img.shields.io/github/workflow/status/ANL-CEEESA/MIPLearn/Test) +![BSD License](https://img.shields.io/badge/license-BSD-blue) + MIPLearn ======== -**MIPLearn** is an extensible framework for *Learning-Enhanced Mixed-Integer Optimization*, an approach targeted at discrete optimization problems that need to be repeatedly solved with only minor changes to input data. The package uses Machine Learning (ML) to automatically identify patterns in previously solved instances of the problem, or in the solution process itself, and produces hints that can guide a conventional MIP solver towards the optimal solution faster. For particular classes of problems, this approach has been shown to provide significant performance benefits. +**MIPLearn** is an extensible framework for **Learning-Enhanced Mixed-Integer Optimization**, an approach targeted at discrete optimization problems that need to be repeatedly solved with only minor changes to input data. + +The package uses Machine Learning (ML) to automatically identify patterns in previously solved instances of the problem, or in the solution process itself, and produces hints that can guide a conventional MIP solver towards the optimal solution faster. For particular classes of problems, this approach has been shown to provide significant performance benefits (see [benchmarks](https://anl-ceeesa.github.io/MIPLearn/problems/) and [references](https://anl-ceeesa.github.io/MIPLearn/about/)). Features -------- -* **MIPLearn proposes a flexible problem specification format,** which allows users to describe their particular optimization problems to a Learning-Enhanced MIP solver, both from the MIP perspective and from the ML perspective, without making any assumptions on the problem being modeled, the mathematical formulation of the problem, or ML encoding. While the format is very flexible, some constraints are enforced to ensure that it is usable by an actual solver. +* **MIPLearn proposes a flexible problem specification format,** which allows users to describe their particular optimization problems to a Learning-Enhanced MIP solver, both from the MIP perspective and from the ML perspective, without making any assumptions on the problem being modeled, the mathematical formulation of the problem, or ML encoding. -* **MIPLearn provides a reference implementation of a *Learning-Enhanced Solver*,** which can use the above problem specification format to automatically predict, based on previously solved instances, a number of hints to accelerate MIP performance. Currently, the reference solver is able to predict: (i) partial solutions which are likely to work well as MIP starts; (ii) an initial set of lazy constraints to enforce; (iii) affine subspaces where the solution is likely to reside; (iv) variable branching priorities to accelerate the exploration of the branch-and-bound tree. The usage of the solver is very straightforward. The most suitable ML models are automatically selected, trained, cross-validated and applied to the problem with no user intervention. +* **MIPLearn provides a reference implementation of a *Learning-Enhanced Solver*,** which can use the above problem specification format to automatically predict, based on previously solved instances, a number of hints to accelerate MIP performance. * **MIPLearn provides a set of benchmark problems and random instance generators,** covering applications from different domains, which can be used to quickly evaluate new learning-enhanced MIP techniques in a measurable and reproducible way. @@ -16,35 +21,10 @@ Features Documentation ------------- -For installation instructions, basic usage and benchmarks results, see the official documentation at: - -* [https://anl-ceeesa.github.io/MIPLearn/](https://anl-ceeesa.github.io/MIPLearn/) +For installation instructions, basic usage and benchmarks results, see the [official documentation](https://anl-ceeesa.github.io/MIPLearn/). License ------- - MIPLearn, an extensible framework for Learning-Enhanced Mixed-Integer Optimization - Copyright © 2020, UChicago Argonne, LLC. All Rights Reserved. - - Redistribution and use in source and binary forms, with or without modification, are permitted - provided that the following conditions are met: - - 1. Redistributions of source code must retain the above copyright notice, this list of - conditions and the following disclaimer. - 2. Redistributions in binary form must reproduce the above copyright notice, this list of - conditions and the following disclaimer in the documentation and/or other materials provided - with the distribution. - 3. Neither the name of the copyright holder nor the names of its contributors may be used to - endorse or promote products derived from this software without specific prior written - permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR - IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY - AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR - CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR - SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR - OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - POSSIBILITY OF SUCH DAMAGE. +Released under the modified BSD license. See `COPYING.md` for mode details. diff --git a/docs-src/index.md b/docs-src/index.md index fd4f555..6f1e30a 100644 --- a/docs-src/index.md +++ b/docs-src/index.md @@ -1,6 +1,8 @@ # MIPLearn -**MIPLearn** is an extensible framework for *Learning-Enhanced Mixed-Integer Optimization*, an approach targeted at discrete optimization problems that need to be repeatedly solved with only minor changes to input data. The package uses Machine Learning (ML) to automatically identify patterns in previously solved instances of the problem, or in the solution process itself, and produces hints that can guide a conventional MIP solver towards the optimal solution faster. For particular classes of problems, this approach has been shown to provide significant performance benefits (see [benchmark results](benchmark.md#benchmark-results) and [references](about.md#references) for more details). +**MIPLearn** is an extensible framework for **Learning-Enhanced Mixed-Integer Optimization**, an approach targeted at discrete optimization problems that need to be repeatedly solved with only minor changes to input data. + +The package uses Machine Learning (ML) to automatically identify patterns in previously solved instances of the problem, or in the solution process itself, and produces hints that can guide a conventional MIP solver towards the optimal solution faster. For particular classes of problems, this approach has been shown to provide significant performance benefits (see [benchmark results](problems.md) and [references](about.md#references) for more details). ### Features @@ -22,5 +24,5 @@ ### Souce Code -* [https://github.com/iSoron/miplearn](https://github.com/iSoron/miplearn) +* [https://github.com/ANL-CEEESA/MIPLearn](https://github.com/ANL-CEEESA/MIPLearn) diff --git a/docs-src/problems.md b/docs-src/problems.md index 98d92ab..c1e9872 100644 --- a/docs-src/problems.md +++ b/docs-src/problems.md @@ -30,9 +30,7 @@ Given a simple undirected graph $G=(V,E)$ and weights $w \in \mathbb{R}^V$, the The class `MaxWeightStableSetGenerator` can be used to generate random instances of this problem, with user-specified probability distributions. When the constructor parameter `fix_graph=True` is provided, one random Erdős-Rényi graph $G_{n,p}$ is generated during the constructor, where $n$ and $p$ are sampled from user-provided probability distributions `n` and `p`. To generate each instance, the generator independently samples each $w_v$ from the user-provided probability distribution `w`. When `fix_graph=False`, a new random graph is generated for each instance, while the remaining parameters are sampled in the same way. -### Benchmark challenges - -#### Challenge A +### Challenge A * Fixed random Erdős-Rényi graph $G_{n,p}$ with $n=200$ and $p=5\%$ * Random vertex weights $w_v \sim U(100, 150)$ @@ -96,7 +94,7 @@ By default, all generated prices, weights and capacities are rounded to the near * Freville, Arnaud, and Gérard Plateau. *An efficient preprocessing procedure for the multidimensional 0–1 knapsack problem.* Discrete applied mathematics 49.1-3 (1994): 189-212. * Fréville, Arnaud. *The multidimensional 0–1 knapsack problem: An overview.* European Journal of Operational Research 155.1 (2004): 1-21. -#### Challenge A +### Challenge A * 250 variables, 10 constraints, fixed weights * $w \sim U(0, 1000), \gamma \sim U(0.95, 1.05)$ diff --git a/docs/index.html b/docs/index.html index 595ee18..d7f582a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -148,7 +148,8 @@

MIPLearn

-

MIPLearn is an extensible framework for Learning-Enhanced Mixed-Integer Optimization, an approach targeted at discrete optimization problems that need to be repeatedly solved with only minor changes to input data. The package uses Machine Learning (ML) to automatically identify patterns in previously solved instances of the problem, or in the solution process itself, and produces hints that can guide a conventional MIP solver towards the optimal solution faster. For particular classes of problems, this approach has been shown to provide significant performance benefits (see benchmark results and references for more details).

+

MIPLearn is an extensible framework for Learning-Enhanced Mixed-Integer Optimization, an approach targeted at discrete optimization problems that need to be repeatedly solved with only minor changes to input data.

+

The package uses Machine Learning (ML) to automatically identify patterns in previously solved instances of the problem, or in the solution process itself, and produces hints that can guide a conventional MIP solver towards the optimal solution faster. For particular classes of problems, this approach has been shown to provide significant performance benefits (see benchmark results and references for more details).

Features

Souce Code

@@ -271,5 +272,5 @@ diff --git a/docs/problems/index.html b/docs/problems/index.html index 5a9b042..ff7c725 100644 --- a/docs/problems/index.html +++ b/docs/problems/index.html @@ -145,11 +145,12 @@
  • Problem definition
  • Random instance generator
    • -
  • Benchmark challenges
    • +
  • Challenge A
  • Multidimensional 0-1 Knapsack Problem
  • Problem definition
  • Random instance generator
    • +
  • Challenge A
    • @@ -173,8 +174,7 @@

    Given a simple undirected graph $G=(V,E)$ and weights $w \in \mathbb{R}^V$, the problem is to find a stable set $S \subseteq V$ that maximizes $ \sum_{v \in V} w_v$. We recall that a subset $S \subseteq V$ is a stable set if no two vertices of $S$ are adjacent. This is one of Karp's 21 NP-complete problems.

    Random instance generator

    The class MaxWeightStableSetGenerator can be used to generate random instances of this problem, with user-specified probability distributions. When the constructor parameter fix_graph=True is provided, one random Erdős-Rényi graph $G_{n,p}$ is generated during the constructor, where $n$ and $p$ are sampled from user-provided probability distributions n and p. To generate each instance, the generator independently samples each $w_v$ from the user-provided probability distribution w. When fix_graph=False, a new random graph is generated for each instance, while the remaining parameters are sampled in the same way.

    -

    Benchmark challenges

    -

    Challenge A

    +

    Challenge A

    -

    Challenge A

    +

    Challenge A