ANL-CEEESA/MIPLearn
1
0
Fork 0
mirror of https://github.com/ANL-CEEESA/MIPLearn.git synced 2025-12-06 09:28:51 -06:00
Code Issues Packages Projects Releases Wiki Activity

Udpate docs

Browse Source
This commit is contained in:
Alinson S. Xavier
2020-08-29 18:08:32 -05:00
parent 3e77d8291c
commit 42a891276c
3 changed files with 5 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
VERSION Normal file
View File

@@ -0,0 +1 @@
0.1.0

16
docs/usage.md
View File

@@ -1,20 +1,13 @@
# Usage # Usage
### Installation ### Installation
MIPLearn is mainly written in Python, with some components written in Julia. For this In these docs, we describe the Python/Pyomo version of the package, although a [Julia/JuMP version](https://github.com/ANL-CEEESA/MIPLearn.jl) 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.
reason, both Python 3.6+ and Julia 1.3+ are required. A mixed-integer solver is also required, and
its Python bindings must be properly installed. Supported solvers are CPLEX and
Gurobi. Optimization problems currently need to be specified in the Pyomo modeling language.
A JuMP interface to the package is currently under development.
To install MIPLearn, run the following commands: To install MIPLearn, run:
```bash ```bash
git clone https://github.com/ANL-CEEESA/MIPLearn.git pip3 install miplearn
cd MIPLearn
make install
``` ```
After installation, the package `miplearn` should become available to Python. It can be imported After installation, the package `miplearn` should become available to Python. It can be imported
@@ -24,9 +17,6 @@ as follows:
import miplearn import miplearn
``` ```
!!! note
To install MIPLearn in another Python environment, switch to that environment before running `make install`. To install the package in development mode, run `make develop` instead.
### Using `LearningSolver` ### Using `LearningSolver`
The main class provided by this package is `LearningSolver`, 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: The main class provided by this package is `LearningSolver`, 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:

2
mkdocs.yml
View File

@@ -2,7 +2,7 @@ site_name: MIPLearn
theme: cinder theme: cinder
copyright: "Copyright © 2020, UChicago Argonne, LLC. All Rights Reserved." copyright: "Copyright © 2020, UChicago Argonne, LLC. All Rights Reserved."
repo_url: https://github.com/ANL-CEEESA/MIPLearn repo_url: https://github.com/ANL-CEEESA/MIPLearn
edit_uri: edit/master/src/docs/ edit_uri: edit/dev/docs/
nav: nav:
- Home: index.md - Home: index.md
- Usage: usage.md - Usage: usage.md