ANL-CEEESA
/
MIPLearn
mirror of https://github.com/ANL-CEEESA/MIPLearn.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update

Browse Source
docs
Alinson S. Xavier 5 years ago
parent 6d2e82f6b9
commit b0b80a94dd
4 changed files with 5 additions and 15 deletions
Show Stats Download Patch File Download Diff File

2
dev/index.html
Unescape View File

@ -269,5 +269,5 @@
<!-- <!--
MkDocs version : 1.0.4 MkDocs version : 1.0.4
Build Date UTC : 2020-08-29 22:52:03 Build Date UTC : 2020-08-29 23:08:22
--> -->

2
dev/search/search_index.json
View File

File diff suppressed because one or more lines are too long

BIN
dev/sitemap.xml.gz
View File

Binary file not shown.

16
dev/usage/index.html
Unescape View File

@ -151,15 +151,9 @@
<h1 id="usage">Usage</h1> <h1 id="usage">Usage</h1>
<h3 id="installation">Installation</h3> <h3 id="installation">Installation</h3>
<p>MIPLearn is mainly written in Python, with some components written in Julia. For this <p>In these docs, we describe the Python/Pyomo version of the package, although a <a href="https://github.com/ANL-CEEESA/MIPLearn.jl">Julia/JuMP version</a> is also available. A mixed-integer solver is also required and its Python bindings must be properly installed. Supported solvers are currently CPLEX and Gurobi.</p>
reason, both Python 3.6+ and Julia 1.3+ are required. A mixed-integer solver is also required, and <p>To install MIPLearn, run: </p>
its Python bindings must be properly installed. Supported solvers are CPLEX and <pre><code class="bash">pip3 install miplearn
Gurobi. Optimization problems currently need to be specified in the Pyomo modeling language.
A JuMP interface to the package is currently under development.</p>
<p>To install MIPLearn, run the following commands: </p>
<pre><code class="bash">git clone https://github.com/ANL-CEEESA/MIPLearn.git
cd MIPLearn
make install
</code></pre> </code></pre>
<p>After installation, the package <code>miplearn</code> should become available to Python. It can be imported <p>After installation, the package <code>miplearn</code> should become available to Python. It can be imported
@ -167,10 +161,6 @@ as follows:</p>
<pre><code class="python">import miplearn <pre><code class="python">import miplearn
</code></pre> </code></pre>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>To install MIPLearn in another Python environment, switch to that environment before running <code>make install</code>. To install the package in development mode, run <code>make develop</code> instead.</p>
</div>
<h3 id="using-learningsolver">Using <code>LearningSolver</code></h3> <h3 id="using-learningsolver">Using <code>LearningSolver</code></h3>
<p>The main class provided by this package is <code>LearningSolver</code>, a learning-enhanced MIP solver which uses information from previously solved instances to accelerate the solution of new instances. The following example shows its basic usage:</p> <p>The main class provided by this package is <code>LearningSolver</code>, a learning-enhanced MIP solver which uses information from previously solved instances to accelerate the solution of new instances. The following example shows its basic usage:</p>
<pre><code class="python">from miplearn import LearningSolver <pre><code class="python">from miplearn import LearningSolver

Write Preview
Loading…
Cancel
Save