You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
331 lines
14 KiB
331 lines
14 KiB
|
|
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>MIPLearn — MIPLearn<br/><small>0.2.0</small></title>
|
|
|
|
<link href="_static/css/theme.css" rel="stylesheet" />
|
|
<link href="_static/css/index.c5995385ac14fb8791e8eb36b4908be2.css" rel="stylesheet" />
|
|
|
|
|
|
<link rel="stylesheet"
|
|
href="_static/vendor/fontawesome/5.13.0/css/all.min.css">
|
|
<link rel="preload" as="font" type="font/woff2" crossorigin
|
|
href="_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
|
|
<link rel="preload" as="font" type="font/woff2" crossorigin
|
|
href="_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/sphinx-book-theme.acff12b8f9c144ce68a297486a2fa670.css" type="text/css" />
|
|
<link rel="stylesheet" type="text/css" href="_static/custom.css" />
|
|
|
|
<link rel="preload" as="script" href="_static/js/index.1c5a1a01449ed65a7b51.js">
|
|
|
|
<script id="documentation_options" data-url_root="" src="_static/documentation_options.js"></script>
|
|
<script src="_static/jquery.js"></script>
|
|
<script src="_static/underscore.js"></script>
|
|
<script src="_static/doctools.js"></script>
|
|
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
|
|
<script src="_static/sphinx-book-theme.12a9622fbb08dcb3a2a40b2c02b83a57.js"></script>
|
|
<link rel="index" title="Index" href="genindex/" />
|
|
<link rel="search" title="Search" href="search/" />
|
|
<link rel="next" title="1. Getting started with MIPLearn" href="jump-tutorials/getting-started/" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
<meta name="docsearch:language" content="en" />
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
|
|
|
|
<div class="container-fluid" id="banner"></div>
|
|
|
|
|
|
|
|
<div class="container-xl">
|
|
<div class="row">
|
|
|
|
<div class="col-12 col-md-3 bd-sidebar site-navigation show" id="site-navigation">
|
|
|
|
<div class="navbar-brand-box">
|
|
<a class="navbar-brand text-wrap" href="#">
|
|
|
|
|
|
<h1 class="site-logo" id="site-title">MIPLearn<br/><small>0.2.0</small></h1>
|
|
|
|
</a>
|
|
</div><form class="bd-search d-flex align-items-center" action="search/" method="get">
|
|
<i class="icon fas fa-search"></i>
|
|
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
|
|
</form><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
|
|
<div class="bd-toc-item active">
|
|
<p class="caption">
|
|
<span class="caption-text">
|
|
Julia Tutorials
|
|
</span>
|
|
</p>
|
|
<ul class="nav bd-sidenav">
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="jump-tutorials/getting-started/">
|
|
1. Getting started with MIPLearn
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption">
|
|
<span class="caption-text">
|
|
Benchmarks
|
|
</span>
|
|
</p>
|
|
<ul class="nav bd-sidenav">
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="benchmarks/preliminaries/">
|
|
1. Preliminaries
|
|
</a>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="benchmarks/stab/">
|
|
2. Maximum Weight Stable Set
|
|
</a>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="benchmarks/knapsack/">
|
|
3. Multidimensional Knapsack
|
|
</a>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="benchmarks/tsp/">
|
|
4. Traveling Salesman
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</nav> <!-- To handle the deprecated key -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<main class="col py-md-3 pl-md-4 bd-content overflow-auto" role="main">
|
|
|
|
<div class="topbar container-xl fixed-top">
|
|
<div class="topbar-contents row">
|
|
<div class="col-12 col-md-3 bd-topbar-whitespace site-navigation show"></div>
|
|
<div class="col pl-md-4 topbar-main">
|
|
|
|
<button id="navbar-toggler" class="navbar-toggler ml-0" type="button" data-toggle="collapse"
|
|
data-toggle="tooltip" data-placement="bottom" data-target=".site-navigation" aria-controls="navbar-menu"
|
|
aria-expanded="true" aria-label="Toggle navigation" aria-controls="site-navigation"
|
|
title="Toggle navigation" data-toggle="tooltip" data-placement="left">
|
|
<i class="fas fa-bars"></i>
|
|
<i class="fas fa-arrow-left"></i>
|
|
<i class="fas fa-arrow-up"></i>
|
|
</button>
|
|
|
|
|
|
<div class="dropdown-buttons-trigger">
|
|
<button id="dropdown-buttons-trigger" class="btn btn-secondary topbarbtn" aria-label="Download this page"><i
|
|
class="fas fa-download"></i></button>
|
|
|
|
<div class="dropdown-buttons">
|
|
<!-- ipynb file if we had a myst markdown file -->
|
|
|
|
<!-- Download raw file -->
|
|
<a class="dropdown-buttons" href="_sources/index.md.txt"><button type="button"
|
|
class="btn btn-secondary topbarbtn" title="Download source file" data-toggle="tooltip"
|
|
data-placement="left">.md</button></a>
|
|
<!-- Download PDF via print -->
|
|
<button type="button" id="download-print" class="btn btn-secondary topbarbtn" title="Print to PDF"
|
|
onClick="window.print()" data-toggle="tooltip" data-placement="left">.pdf</button>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Source interaction buttons -->
|
|
|
|
<!-- Full screen (wrap in <a> to have style consistency -->
|
|
|
|
<a class="full-screen-button"><button type="button" class="btn btn-secondary topbarbtn" data-toggle="tooltip"
|
|
data-placement="bottom" onclick="toggleFullScreen()" aria-label="Fullscreen mode"
|
|
title="Fullscreen mode"><i
|
|
class="fas fa-expand"></i></button></a>
|
|
|
|
<!-- Launch buttons -->
|
|
|
|
</div>
|
|
|
|
<!-- Table of contents -->
|
|
<div class="d-none d-md-block col-md-2 bd-toc show">
|
|
|
|
<div class="tocsection onthispage pt-5 pb-3">
|
|
<i class="fas fa-list"></i> Contents
|
|
</div>
|
|
<nav id="bd-toc-nav">
|
|
<ul class="visible nav section-nav flex-column">
|
|
<li class="toc-h2 nav-item toc-entry">
|
|
<a class="reference internal nav-link" href="#table-of-contents">
|
|
Table of Contents
|
|
</a>
|
|
<ul class="nav section-nav flex-column">
|
|
</ul>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry">
|
|
<a class="reference internal nav-link" href="#source-code">
|
|
Source Code
|
|
</a>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry">
|
|
<a class="reference internal nav-link" href="#authors">
|
|
Authors
|
|
</a>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry">
|
|
<a class="reference internal nav-link" href="#acknowledgments">
|
|
Acknowledgments
|
|
</a>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry">
|
|
<a class="reference internal nav-link" href="#references">
|
|
References
|
|
</a>
|
|
</li>
|
|
<li class="toc-h2 nav-item toc-entry">
|
|
<a class="reference internal nav-link" href="#license">
|
|
License
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="main-content" class="row">
|
|
<div class="col-12 col-md-9 pl-md-3 pr-md-0">
|
|
|
|
<div>
|
|
|
|
<div class="section" id="miplearn">
|
|
<h1>MIPLearn<a class="headerlink" href="#miplearn" title="Permalink to this headline">¶</a></h1>
|
|
<p><strong>MIPLearn</strong> is an extensible framework for solving discrete optimization problems using a combination of Mixed-Integer Linear Programming (MIP) and Machine Learning (ML). The framework uses ML methods to automatically identify patterns in previously solved instances of the problem, then uses these patterns to accelerate the performance of conventional state-of-the-art MIP solvers (such as CPLEX, Gurobi or XPRESS).</p>
|
|
<p>Unlike pure ML methods, MIPLearn is not only able to find high-quality solutions to discrete optimization problems, but it can also prove the optimality and feasibility of these solutions.
|
|
Unlike conventional MIP solvers, MIPLearn can take full advantage of very specific observations that happen to be true in a particular family of instances (such as the observation that a particular constraint is typically redundant, or that a particular variable typically assumes a certain value).</p>
|
|
<div class="section" id="table-of-contents">
|
|
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline">¶</a></h2>
|
|
<div class="toctree-wrapper compound">
|
|
<p class="caption"><span class="caption-text">Julia Tutorials</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="jump-tutorials/getting-started/">1. Getting started with MIPLearn</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="toctree-wrapper compound">
|
|
<p class="caption"><span class="caption-text">Benchmarks</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="benchmarks/preliminaries/">1. Preliminaries</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="benchmarks/stab/">2. Maximum Weight Stable Set</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="benchmarks/knapsack/">3. Multidimensional Knapsack</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="benchmarks/tsp/">4. Traveling Salesman</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="toctree-wrapper compound">
|
|
</div>
|
|
</div>
|
|
<div class="section" id="source-code">
|
|
<h2>Source Code<a class="headerlink" href="#source-code" title="Permalink to this headline">¶</a></h2>
|
|
<ul class="simple">
|
|
<li><p><a class="reference external" href="https://github.com/ANL-CEEESA/MIPLearn">https://github.com/ANL-CEEESA/MIPLearn</a></p></li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="authors">
|
|
<h2>Authors<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h2>
|
|
<ul class="simple">
|
|
<li><p><strong>Alinson S. Xavier,</strong> Argonne National Laboratory <<a class="reference external" href="mailto:axavier%40anl.gov">mailto:axavier<span>@</span>anl<span>.</span>gov</a>></p></li>
|
|
<li><p><strong>Feng Qiu,</strong> Argonne National Laboratory <<a class="reference external" href="mailto:fqiu%40anl.gov">mailto:fqiu<span>@</span>anl<span>.</span>gov</a>></p></li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="acknowledgments">
|
|
<h2>Acknowledgments<a class="headerlink" href="#acknowledgments" title="Permalink to this headline">¶</a></h2>
|
|
<ul class="simple">
|
|
<li><p>Based upon work supported by <strong>Laboratory Directed Research and Development</strong> (LDRD) funding from Argonne National Laboratory, provided by the Director, Office of Science, of the U.S. Department of Energy under Contract No. DE-AC02-06CH11357, and the <strong>U.S. Department of Energy Advanced Grid Modeling Program</strong> under Grant DE-OE0000875.</p></li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="references">
|
|
<h2>References<a class="headerlink" href="#references" title="Permalink to this headline">¶</a></h2>
|
|
<p>If you use MIPLearn in your research, or the included problem generators, we kindly request that you cite the package as follows:</p>
|
|
<ul class="simple">
|
|
<li><p><strong>Alinson S. Xavier, Feng Qiu.</strong> <em>MIPLearn: An Extensible Framework for Learning-Enhanced Optimization</em>. Zenodo (2020). DOI: <a class="reference external" href="https://doi.org/10.5281/zenodo.4287567">10.5281/zenodo.4287567</a></p></li>
|
|
</ul>
|
|
<p>If you use MIPLearn in the field of power systems optimization, we kindly request that you cite the reference below, in which the main techniques implemented in MIPLearn were first developed:</p>
|
|
<ul class="simple">
|
|
<li><p><strong>Alinson S. Xavier, Feng Qiu, Shabbir Ahmed.</strong> <em>Learning to Solve Large-Scale Unit Commitment Problems.</em> INFORMS Journal on Computing (2021). DOI: <a class="reference external" href="https://doi.org/10.1287/ijoc.2020.0976">10.1287/ijoc.2020.0976</a></p></li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="license">
|
|
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
|
|
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>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.
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class='prev-next-bottom'>
|
|
|
|
<a class='right-next' id="next-link" href="jump-tutorials/getting-started/" title="next page"><span class="section-number">1. </span>Getting started with MIPLearn</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<footer class="footer mt-5 mt-md-0">
|
|
<div class="container">
|
|
<p>
|
|
|
|
© Copyright 2020-2021, UChicago Argonne, LLC.<br/>
|
|
</p>
|
|
</div>
|
|
</footer>
|
|
</main>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<script src="_static/js/index.1c5a1a01449ed65a7b51.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |