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.
MIPLearn/0.2/api/miplearn/solvers/tests/test_internal_solver.html

543 lines
23 KiB

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.7.0" />
<title>miplearn.solvers.tests.test_internal_solver API documentation</title>
<meta name="description" content="" />
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>miplearn.solvers.tests.test_internal_solver</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python"># MIPLearn: Extensible Framework for Learning-Enhanced Mixed-Integer Optimization
# Copyright (C) 2020, UChicago Argonne, LLC. All rights reserved.
# Released under the modified BSD license. See COPYING.md for more details.
import logging
from io import StringIO
from warnings import warn
import pyomo.environ as pe
from miplearn.solvers import _RedirectOutput
from miplearn.solvers.gurobi import GurobiSolver
from miplearn.solvers.pyomo.base import BasePyomoSolver
from miplearn.solvers.tests import (
_get_knapsack_instance,
_get_internal_solvers,
_get_infeasible_instance,
)
logger = logging.getLogger(__name__)
def test_redirect_output():
import sys
original_stdout = sys.stdout
io = StringIO()
with _RedirectOutput([io]):
print(&#34;Hello world&#34;)
assert sys.stdout == original_stdout
assert io.getvalue() == &#34;Hello world\n&#34;
def test_internal_solver_warm_starts():
for solver_class in _get_internal_solvers():
logger.info(&#34;Solver: %s&#34; % solver_class)
instance = _get_knapsack_instance(solver_class)
model = instance.to_model()
solver = solver_class()
solver.set_instance(instance, model)
solver.set_warm_start(
{
&#34;x&#34;: {
0: 1.0,
1: 0.0,
2: 0.0,
3: 1.0,
}
}
)
stats = solver.solve(tee=True)
if stats[&#34;Warm start value&#34;] is not None:
assert stats[&#34;Warm start value&#34;] == 725.0
else:
warn(f&#34;{solver_class.__name__} should set warm start value&#34;)
solver.set_warm_start(
{
&#34;x&#34;: {
0: 1.0,
1: 1.0,
2: 1.0,
3: 1.0,
}
}
)
stats = solver.solve(tee=True)
assert stats[&#34;Warm start value&#34;] is None
solver.fix(
{
&#34;x&#34;: {
0: 1.0,
1: 0.0,
2: 0.0,
3: 1.0,
}
}
)
stats = solver.solve(tee=True)
assert stats[&#34;Lower bound&#34;] == 725.0
assert stats[&#34;Upper bound&#34;] == 725.0
def test_internal_solver():
for solver_class in _get_internal_solvers():
logger.info(&#34;Solver: %s&#34; % solver_class)
instance = _get_knapsack_instance(solver_class)
model = instance.to_model()
solver = solver_class()
solver.set_instance(instance, model)
stats = solver.solve_lp()
assert not solver.is_infeasible()
assert round(stats[&#34;Optimal value&#34;], 3) == 1287.923
assert len(stats[&#34;Log&#34;]) &gt; 100
solution = solver.get_solution()
assert round(solution[&#34;x&#34;][0], 3) == 1.000
assert round(solution[&#34;x&#34;][1], 3) == 0.923
assert round(solution[&#34;x&#34;][2], 3) == 1.000
assert round(solution[&#34;x&#34;][3], 3) == 0.000
stats = solver.solve(tee=True)
assert not solver.is_infeasible()
assert len(stats[&#34;Log&#34;]) &gt; 100
assert stats[&#34;Lower bound&#34;] == 1183.0
assert stats[&#34;Upper bound&#34;] == 1183.0
assert stats[&#34;Sense&#34;] == &#34;max&#34;
assert isinstance(stats[&#34;Wallclock time&#34;], float)
solution = solver.get_solution()
assert solution[&#34;x&#34;][0] == 1.0
assert solution[&#34;x&#34;][1] == 0.0
assert solution[&#34;x&#34;][2] == 1.0
assert solution[&#34;x&#34;][3] == 1.0
# Add a brand new constraint
if isinstance(solver, BasePyomoSolver):
model.cut = pe.Constraint(expr=model.x[0] &lt;= 0.0, name=&#34;cut&#34;)
solver.add_constraint(model.cut)
elif isinstance(solver, GurobiSolver):
x = model.getVarByName(&#34;x[0]&#34;)
solver.add_constraint(x &lt;= 0.0, name=&#34;cut&#34;)
else:
raise Exception(&#34;Illegal state&#34;)
# New constraint should affect solution and should be listed in
# constraint ids
assert solver.get_constraint_ids() == [&#34;eq_capacity&#34;, &#34;cut&#34;]
stats = solver.solve()
assert stats[&#34;Lower bound&#34;] == 1030.0
assert solver.get_sense() == &#34;max&#34;
assert solver.get_constraint_sense(&#34;cut&#34;) == &#34;&lt;&#34;
assert solver.get_constraint_sense(&#34;eq_capacity&#34;) == &#34;&lt;&#34;
# Verify slacks
assert solver.get_inequality_slacks() == {
&#34;cut&#34;: 0.0,
&#34;eq_capacity&#34;: 3.0,
}
if isinstance(solver, GurobiSolver):
# Extract the new constraint
cobj = solver.extract_constraint(&#34;cut&#34;)
# New constraint should no longer affect solution and should no longer
# be listed in constraint ids
assert solver.get_constraint_ids() == [&#34;eq_capacity&#34;]
stats = solver.solve()
assert stats[&#34;Lower bound&#34;] == 1183.0
# New constraint should not be satisfied by current solution
assert not solver.is_constraint_satisfied(cobj)
# Re-add constraint
solver.add_constraint(cobj)
# Constraint should affect solution again
assert solver.get_constraint_ids() == [&#34;eq_capacity&#34;, &#34;cut&#34;]
stats = solver.solve()
assert stats[&#34;Lower bound&#34;] == 1030.0
# New constraint should now be satisfied
assert solver.is_constraint_satisfied(cobj)
# Relax problem and make cut into an equality constraint
solver.relax()
solver.set_constraint_sense(&#34;cut&#34;, &#34;=&#34;)
stats = solver.solve()
assert round(stats[&#34;Lower bound&#34;]) == 1030.0
assert round(solver.get_dual(&#34;eq_capacity&#34;)) == 0.0
def test_relax():
for solver_class in _get_internal_solvers():
instance = _get_knapsack_instance(solver_class)
solver = solver_class()
solver.set_instance(instance)
solver.relax()
stats = solver.solve()
assert round(stats[&#34;Lower bound&#34;]) == 1288.0
def test_infeasible_instance():
for solver_class in _get_internal_solvers():
instance = _get_infeasible_instance(solver_class)
solver = solver_class()
solver.set_instance(instance)
stats = solver.solve()
assert solver.is_infeasible()
assert solver.get_solution() is None
assert stats[&#34;Upper bound&#34;] is None
assert stats[&#34;Lower bound&#34;] is None
stats = solver.solve_lp()
assert solver.get_solution() is None
assert stats[&#34;Optimal value&#34;] is None
assert solver.get_value(&#34;x&#34;, 0) is None
def test_iteration_cb():
for solver_class in _get_internal_solvers():
logger.info(&#34;Solver: %s&#34; % solver_class)
instance = _get_knapsack_instance(solver_class)
solver = solver_class()
solver.set_instance(instance)
count = 0
def custom_iteration_cb():
nonlocal count
count += 1
return count &lt; 5
solver.solve(iteration_cb=custom_iteration_cb)
assert count == 5</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="miplearn.solvers.tests.test_internal_solver.test_infeasible_instance"><code class="name flex">
<span>def <span class="ident">test_infeasible_instance</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_infeasible_instance():
for solver_class in _get_internal_solvers():
instance = _get_infeasible_instance(solver_class)
solver = solver_class()
solver.set_instance(instance)
stats = solver.solve()
assert solver.is_infeasible()
assert solver.get_solution() is None
assert stats[&#34;Upper bound&#34;] is None
assert stats[&#34;Lower bound&#34;] is None
stats = solver.solve_lp()
assert solver.get_solution() is None
assert stats[&#34;Optimal value&#34;] is None
assert solver.get_value(&#34;x&#34;, 0) is None</code></pre>
</details>
</dd>
<dt id="miplearn.solvers.tests.test_internal_solver.test_internal_solver"><code class="name flex">
<span>def <span class="ident">test_internal_solver</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_internal_solver():
for solver_class in _get_internal_solvers():
logger.info(&#34;Solver: %s&#34; % solver_class)
instance = _get_knapsack_instance(solver_class)
model = instance.to_model()
solver = solver_class()
solver.set_instance(instance, model)
stats = solver.solve_lp()
assert not solver.is_infeasible()
assert round(stats[&#34;Optimal value&#34;], 3) == 1287.923
assert len(stats[&#34;Log&#34;]) &gt; 100
solution = solver.get_solution()
assert round(solution[&#34;x&#34;][0], 3) == 1.000
assert round(solution[&#34;x&#34;][1], 3) == 0.923
assert round(solution[&#34;x&#34;][2], 3) == 1.000
assert round(solution[&#34;x&#34;][3], 3) == 0.000
stats = solver.solve(tee=True)
assert not solver.is_infeasible()
assert len(stats[&#34;Log&#34;]) &gt; 100
assert stats[&#34;Lower bound&#34;] == 1183.0
assert stats[&#34;Upper bound&#34;] == 1183.0
assert stats[&#34;Sense&#34;] == &#34;max&#34;
assert isinstance(stats[&#34;Wallclock time&#34;], float)
solution = solver.get_solution()
assert solution[&#34;x&#34;][0] == 1.0
assert solution[&#34;x&#34;][1] == 0.0
assert solution[&#34;x&#34;][2] == 1.0
assert solution[&#34;x&#34;][3] == 1.0
# Add a brand new constraint
if isinstance(solver, BasePyomoSolver):
model.cut = pe.Constraint(expr=model.x[0] &lt;= 0.0, name=&#34;cut&#34;)
solver.add_constraint(model.cut)
elif isinstance(solver, GurobiSolver):
x = model.getVarByName(&#34;x[0]&#34;)
solver.add_constraint(x &lt;= 0.0, name=&#34;cut&#34;)
else:
raise Exception(&#34;Illegal state&#34;)
# New constraint should affect solution and should be listed in
# constraint ids
assert solver.get_constraint_ids() == [&#34;eq_capacity&#34;, &#34;cut&#34;]
stats = solver.solve()
assert stats[&#34;Lower bound&#34;] == 1030.0
assert solver.get_sense() == &#34;max&#34;
assert solver.get_constraint_sense(&#34;cut&#34;) == &#34;&lt;&#34;
assert solver.get_constraint_sense(&#34;eq_capacity&#34;) == &#34;&lt;&#34;
# Verify slacks
assert solver.get_inequality_slacks() == {
&#34;cut&#34;: 0.0,
&#34;eq_capacity&#34;: 3.0,
}
if isinstance(solver, GurobiSolver):
# Extract the new constraint
cobj = solver.extract_constraint(&#34;cut&#34;)
# New constraint should no longer affect solution and should no longer
# be listed in constraint ids
assert solver.get_constraint_ids() == [&#34;eq_capacity&#34;]
stats = solver.solve()
assert stats[&#34;Lower bound&#34;] == 1183.0
# New constraint should not be satisfied by current solution
assert not solver.is_constraint_satisfied(cobj)
# Re-add constraint
solver.add_constraint(cobj)
# Constraint should affect solution again
assert solver.get_constraint_ids() == [&#34;eq_capacity&#34;, &#34;cut&#34;]
stats = solver.solve()
assert stats[&#34;Lower bound&#34;] == 1030.0
# New constraint should now be satisfied
assert solver.is_constraint_satisfied(cobj)
# Relax problem and make cut into an equality constraint
solver.relax()
solver.set_constraint_sense(&#34;cut&#34;, &#34;=&#34;)
stats = solver.solve()
assert round(stats[&#34;Lower bound&#34;]) == 1030.0
assert round(solver.get_dual(&#34;eq_capacity&#34;)) == 0.0</code></pre>
</details>
</dd>
<dt id="miplearn.solvers.tests.test_internal_solver.test_internal_solver_warm_starts"><code class="name flex">
<span>def <span class="ident">test_internal_solver_warm_starts</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_internal_solver_warm_starts():
for solver_class in _get_internal_solvers():
logger.info(&#34;Solver: %s&#34; % solver_class)
instance = _get_knapsack_instance(solver_class)
model = instance.to_model()
solver = solver_class()
solver.set_instance(instance, model)
solver.set_warm_start(
{
&#34;x&#34;: {
0: 1.0,
1: 0.0,
2: 0.0,
3: 1.0,
}
}
)
stats = solver.solve(tee=True)
if stats[&#34;Warm start value&#34;] is not None:
assert stats[&#34;Warm start value&#34;] == 725.0
else:
warn(f&#34;{solver_class.__name__} should set warm start value&#34;)
solver.set_warm_start(
{
&#34;x&#34;: {
0: 1.0,
1: 1.0,
2: 1.0,
3: 1.0,
}
}
)
stats = solver.solve(tee=True)
assert stats[&#34;Warm start value&#34;] is None
solver.fix(
{
&#34;x&#34;: {
0: 1.0,
1: 0.0,
2: 0.0,
3: 1.0,
}
}
)
stats = solver.solve(tee=True)
assert stats[&#34;Lower bound&#34;] == 725.0
assert stats[&#34;Upper bound&#34;] == 725.0</code></pre>
</details>
</dd>
<dt id="miplearn.solvers.tests.test_internal_solver.test_iteration_cb"><code class="name flex">
<span>def <span class="ident">test_iteration_cb</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_iteration_cb():
for solver_class in _get_internal_solvers():
logger.info(&#34;Solver: %s&#34; % solver_class)
instance = _get_knapsack_instance(solver_class)
solver = solver_class()
solver.set_instance(instance)
count = 0
def custom_iteration_cb():
nonlocal count
count += 1
return count &lt; 5
solver.solve(iteration_cb=custom_iteration_cb)
assert count == 5</code></pre>
</details>
</dd>
<dt id="miplearn.solvers.tests.test_internal_solver.test_redirect_output"><code class="name flex">
<span>def <span class="ident">test_redirect_output</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_redirect_output():
import sys
original_stdout = sys.stdout
io = StringIO()
with _RedirectOutput([io]):
print(&#34;Hello world&#34;)
assert sys.stdout == original_stdout
assert io.getvalue() == &#34;Hello world\n&#34;</code></pre>
</details>
</dd>
<dt id="miplearn.solvers.tests.test_internal_solver.test_relax"><code class="name flex">
<span>def <span class="ident">test_relax</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_relax():
for solver_class in _get_internal_solvers():
instance = _get_knapsack_instance(solver_class)
solver = solver_class()
solver.set_instance(instance)
solver.relax()
stats = solver.solve()
assert round(stats[&#34;Lower bound&#34;]) == 1288.0</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="miplearn.solvers.tests" href="index.html">miplearn.solvers.tests</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="miplearn.solvers.tests.test_internal_solver.test_infeasible_instance" href="#miplearn.solvers.tests.test_internal_solver.test_infeasible_instance">test_infeasible_instance</a></code></li>
<li><code><a title="miplearn.solvers.tests.test_internal_solver.test_internal_solver" href="#miplearn.solvers.tests.test_internal_solver.test_internal_solver">test_internal_solver</a></code></li>
<li><code><a title="miplearn.solvers.tests.test_internal_solver.test_internal_solver_warm_starts" href="#miplearn.solvers.tests.test_internal_solver.test_internal_solver_warm_starts">test_internal_solver_warm_starts</a></code></li>
<li><code><a title="miplearn.solvers.tests.test_internal_solver.test_iteration_cb" href="#miplearn.solvers.tests.test_internal_solver.test_iteration_cb">test_iteration_cb</a></code></li>
<li><code><a title="miplearn.solvers.tests.test_internal_solver.test_redirect_output" href="#miplearn.solvers.tests.test_internal_solver.test_redirect_output">test_redirect_output</a></code></li>
<li><code><a title="miplearn.solvers.tests.test_internal_solver.test_relax" href="#miplearn.solvers.tests.test_internal_solver.test_relax">test_relax</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.0</a>.</p>
</footer>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad()</script>
</body>
</html>