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.
383 lines
14 KiB
383 lines
14 KiB
|
|
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Python Module Index — MIPLearn 0.3</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/nbsphinx-code-cells.css" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/nbsphinx-code-cells.css" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/nbsphinx-code-cells.css" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/nbsphinx-code-cells.css" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/nbsphinx-code-cells.css" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/nbsphinx-code-cells.css" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/nbsphinx-code-cells.css" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/nbsphinx-code-cells.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/" />
|
|
|
|
<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 0.3</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">
|
|
Tutorials
|
|
</span>
|
|
</p>
|
|
<ul class="nav bd-sidenav">
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="../tutorials/getting-started-pyomo/">
|
|
1. Getting started (Pyomo)
|
|
</a>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="../tutorials/getting-started-gurobipy/">
|
|
2. Getting started (Gurobipy)
|
|
</a>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="../tutorials/getting-started-jump/">
|
|
3. Getting started (JuMP)
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption">
|
|
<span class="caption-text">
|
|
User Guide
|
|
</span>
|
|
</p>
|
|
<ul class="nav bd-sidenav">
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="../guide/problems/">
|
|
4. Benchmark Problems
|
|
</a>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="../guide/collectors/">
|
|
5. Training Data Collectors
|
|
</a>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="../guide/features/">
|
|
6. Feature Extractors
|
|
</a>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="../guide/primal/">
|
|
7. Primal Components
|
|
</a>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="../guide/solvers/">
|
|
8. Solvers
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption">
|
|
<span class="caption-text">
|
|
Python API Reference
|
|
</span>
|
|
</p>
|
|
<ul class="nav bd-sidenav">
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="../api/problems/">
|
|
9. Benchmark Problems
|
|
</a>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="../api/collectors/">
|
|
10. Collectors & Extractors
|
|
</a>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="../api/components/">
|
|
11. Components
|
|
</a>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="../api/solvers/">
|
|
12. Solvers
|
|
</a>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="../api/helpers/">
|
|
13. Helpers
|
|
</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>
|
|
|
|
|
|
<!-- 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>
|
|
</div>
|
|
</div>
|
|
<div id="main-content" class="row">
|
|
<div class="col-12 col-md-9 pl-md-3 pr-md-0">
|
|
|
|
<div>
|
|
|
|
|
|
<h1>Python Module Index</h1>
|
|
|
|
<div class="modindex-jumpbox">
|
|
<a href="#cap-m"><strong>m</strong></a>
|
|
</div>
|
|
|
|
<table class="indextable modindextable">
|
|
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
|
<tr class="cap" id="cap-m"><td></td><td>
|
|
<strong>m</strong></td><td></td></tr>
|
|
<tr>
|
|
<td><img src="../_static/minus.png" class="toggler"
|
|
id="toggle-1" style="display: none" alt="-" /></td>
|
|
<td>
|
|
<code class="xref">miplearn</code></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/collectors/#module-miplearn.classifiers.minprob"><code class="xref">miplearn.classifiers.minprob</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/collectors/#module-miplearn.classifiers.singleclass"><code class="xref">miplearn.classifiers.singleclass</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/collectors/#module-miplearn.collectors.basic"><code class="xref">miplearn.collectors.basic</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/components/#module-miplearn.components.primal.actions"><code class="xref">miplearn.components.primal.actions</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/components/#module-miplearn.components.primal.expert"><code class="xref">miplearn.components.primal.expert</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/components/#module-miplearn.components.primal.indep"><code class="xref">miplearn.components.primal.indep</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/components/#module-miplearn.components.primal.joint"><code class="xref">miplearn.components.primal.joint</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/components/#module-miplearn.components.primal.mem"><code class="xref">miplearn.components.primal.mem</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/collectors/#module-miplearn.extractors.AlvLouWeh2017"><code class="xref">miplearn.extractors.AlvLouWeh2017</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/collectors/#module-miplearn.extractors.fields"><code class="xref">miplearn.extractors.fields</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/helpers/#module-miplearn.h5"><code class="xref">miplearn.h5</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/helpers/#module-miplearn.io"><code class="xref">miplearn.io</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/problems/#module-miplearn.problems.binpack"><code class="xref">miplearn.problems.binpack</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/problems/#module-miplearn.problems.multiknapsack"><code class="xref">miplearn.problems.multiknapsack</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/problems/#module-miplearn.problems.pmedian"><code class="xref">miplearn.problems.pmedian</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/problems/#module-miplearn.problems.setcover"><code class="xref">miplearn.problems.setcover</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/problems/#module-miplearn.problems.setpack"><code class="xref">miplearn.problems.setpack</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/problems/#module-miplearn.problems.stab"><code class="xref">miplearn.problems.stab</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/problems/#module-miplearn.problems.tsp"><code class="xref">miplearn.problems.tsp</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/problems/#module-miplearn.problems.uc"><code class="xref">miplearn.problems.uc</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/problems/#module-miplearn.problems.vertexcover"><code class="xref">miplearn.problems.vertexcover</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/solvers/#module-miplearn.solvers.abstract"><code class="xref">miplearn.solvers.abstract</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/solvers/#module-miplearn.solvers.gurobi"><code class="xref">miplearn.solvers.gurobi</code></a></td><td>
|
|
<em></em></td></tr>
|
|
<tr class="cg-1">
|
|
<td></td>
|
|
<td>   
|
|
<a href="../api/solvers/#module-miplearn.solvers.learning"><code class="xref">miplearn.solvers.learning</code></a></td><td>
|
|
<em></em></td></tr>
|
|
</table>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class='prev-next-bottom'>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<footer class="footer mt-5 mt-md-0">
|
|
<div class="container">
|
|
<p>
|
|
|
|
© Copyright 2020-2023, UChicago Argonne, LLC.<br/>
|
|
</p>
|
|
</div>
|
|
</footer>
|
|
</main>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<script src="../_static/js/index.1c5a1a01449ed65a7b51.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |