Opened 5 years ago
Last modified 2 months ago
#21003 needs_work enhancement
Add SCIP backend using PySCIPOpt
Reported by:  mkoeppe  Owned by:  

Priority:  major  Milestone:  sage9.5 
Component:  linear programming  Keywords:  lp, days84, IMAPolyGeom 
Cc:  moritz, yzh, malb  Merged in:  
Authors:  Matthias Koeppe, Moritz Firsching  Reviewers:  Moritz Firsching, Vincent Delecroix 
Report Upstream:  N/A  Work issues:  
Branch:  u/mkoeppe/pyscipopt (Commits, GitHub, GitLab)  Commit:  cd0b761b3061010bfabe2c71195f2d804fb8a4e5 
Dependencies:  #31329  Stopgaps: 
Description (last modified by )
This ticket adds a package pyscipopt and adds a new MIP backend based on it.
https://github.com/SCIPInterfaces/PySCIPOpt
Branch is on top of #31329.
Steps to get it to work:
 pull from this branch
 put http://scip.zib.de/download.php?fname=scipoptsuite7.0.2.tgz in
./upstream
 put PySCIPOpt3.1.0.tar.gz in
./upstream
sage f pyscipopt
Change History (74)
comment:1 Changed 5 years ago by
 Description modified (diff)
comment:2 Changed 5 years ago by
 Dependencies changed from #10879 to #21094
comment:3 Changed 5 years ago by
 Branch set to u/mkoeppe/pyscipopt
comment:4 Changed 5 years ago by
 Commit set to db1b1d9c9de824cb25e614b9b39ee838f7f510ad
comment:5 Changed 5 years ago by
 Commit changed from db1b1d9c9de824cb25e614b9b39ee838f7f510ad to 805a0349170376f392c0b1aff410b554d894a4c1
Branch pushed to git repo; I updated commit sha1. New commits:
805a034  Merge tag '7.4.beta0' into t/21003/pyscipopt

comment:6 Changed 5 years ago by
 Commit changed from 805a0349170376f392c0b1aff410b554d894a4c1 to d3271c0e047c6ead45eb7330101db1e2b1c0843f
comment:7 Changed 5 years ago by
 Cc moritz added
comment:8 Changed 5 years ago by
 Commit changed from d3271c0e047c6ead45eb7330101db1e2b1c0843f to 41b70bb400d4a0142f5bbf6ff64756868f4383a5
Branch pushed to git repo; I updated commit sha1. New commits:
41b70bb  PySCIPOpt: Install from git

comment:9 Changed 5 years ago by
 Description modified (diff)
 Milestone changed from sage7.3 to sage7.6
comment:10 Changed 5 years ago by
 Keywords days84 added
comment:11 Changed 5 years ago by
comment:12 Changed 5 years ago by
 Commit changed from 41b70bb400d4a0142f5bbf6ff64756868f4383a5 to d973980c8bea05015dbcc4e28121f77de30eb6a2
comment:13 Changed 5 years ago by
 Dependencies changed from #21094 to #22557
 Description modified (diff)
comment:14 Changed 5 years ago by
 Commit changed from d973980c8bea05015dbcc4e28121f77de30eb6a2 to 9794b3ae7c7b836ddff0e419aaf8a369d0ec76dc
Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:
ccf5e37  Update patches and script for 4.0.0

75fb34c  Use OPT=opt on Linux. Check results of test suite

74f1d79  scip: Working configuration for clang on Mac

0f37658  scipoptsuite: Use clang on Mac OS

607a51c  Add SCIP backend (stubs only)

05a723f  New pip package pyscipopt

74a2875  PySCIPOpt: Install from git

b433c65  pyscipopt: Use real upstream git

9794b3a  SCIPBackend: First step

comment:15 Changed 5 years ago by
 Cc yzh added
comment:16 Changed 4 years ago by
 Dependencies changed from #22557 to #22557, #24662
comment:17 Changed 3 years ago by
 Branch changed from u/mkoeppe/pyscipopt to u/moritz/pyscipopt
comment:18 Changed 3 years ago by
 Commit changed from 9794b3ae7c7b836ddff0e419aaf8a369d0ec76dc to f260221f94bcfeada17fa4836303e8dd57fbd4f7
This (hopefully) works now, after putting PySCIPOpt1.4.0.tar.gz into upstream, which can be found here:
*UPDATE* (from a later edit): now you need to put PySCIPOpt1.4.2.tar.gz https://pypi.python.org/packages/c0/b6/b619a33cd90dbf5579de341c873f85f0388030c47ee5da71a9113ee308d4/PySCIPOpt1.4.2.tar.gz#md5=4f175316bc3ba4ce97c284434a4b62f0
*UPDATE* (from yet a later edit): Check the description of the ticket for the latest version!
Last 10 new commits:
966aeb9  compiling with cmake

057a2c7  add dependency info

f4a061e  use cmake sage package; make output verbose

b86cf01  scipoptsuite: Add patch for using libhistory (needed for Mac OS X)

e94b94e  improving the check

6cce2c7  Add SCIP backend (stubs only)

4eb6e95  New pip package pyscipopt

fbe8e62  PySCIPOpt: Install from git

9c8d7c6  pyscipopt: Use real upstream git

f260221  SCIPBackend: First step

comment:19 Changed 3 years ago by
 Commit changed from f260221f94bcfeada17fa4836303e8dd57fbd4f7 to 8fdae7c429e4814f15fa13bf9ff9b7699586c9a9
Branch pushed to git repo; I updated commit sha1. New commits:
8fdae7c  new version 1.4.0

comment:20 Changed 3 years ago by
 Commit changed from 8fdae7c429e4814f15fa13bf9ff9b7699586c9a9 to 1958470beb6fecca8d71ebd7fbf1dfcf452f7cb9
Branch pushed to git repo; I updated commit sha1. New commits:
1958470  added SPKG.txt

comment:21 Changed 3 years ago by
 Commit changed from 1958470beb6fecca8d71ebd7fbf1dfcf452f7cb9 to 6ebdc937ef5033d45dc7a6107d02c0be56b8970e
comment:22 Changed 3 years ago by
comment:23 Changed 3 years ago by
 Keywords IMAPolyGeom added
 Milestone changed from sage7.6 to sage8.2
comment:24 Changed 3 years ago by
 Commit changed from 6ebdc937ef5033d45dc7a6107d02c0be56b8970e to 1eb34120be1864103d24c7a057e8e30101f6d822
Branch pushed to git repo; I updated commit sha1. New commits:
1eb3412  almost all doctests working, some pyscipopt patches

comment:25 Changed 3 years ago by
 Description modified (diff)
comment:26 Changed 3 years ago by
 Commit changed from 1eb34120be1864103d24c7a057e8e30101f6d822 to a586569de8a5b864cdd5dc431eb61b05825d6dd4
comment:27 Changed 3 years ago by
 Status changed from new to needs_review
In this version, there are a number of patches in the patches
directory. All of them will be merged upstream in a version of pyscipopt with version number >=1.4.3, which should be available on Pypi not too long from now. I will update the pyscipopt package then.
comment:28 Changed 3 years ago by
 Cc malb added
comment:29 Changed 3 years ago by
 Branch changed from u/moritz/pyscipopt to u/mkoeppe/pyscipopt
comment:30 Changed 3 years ago by
 Commit changed from a586569de8a5b864cdd5dc431eb61b05825d6dd4 to 080bc9037c475123d4ed1428150d740d64480001
I merged latest #24662.
All doctests need to be marked # optional  pyscipopt
New commits:
f4ad108  put readline as depency

8b20290  scipoptsuite: Update patch to remove cmake warning

f25f900  scipoptsuite: Set GMP_DIR so that we do not catch /usr/local/include

d49ff94  scipoptsuite: Add patch: ZIMPL cmake scripts: Put ZIMPL includes first to avoid clash of idxset.h with install soplex idxset.h

d7e29d5  scipoptsuite: Fix install name for libscip on Mac

737e606  Make bliss and MP_LIBRARY dependencies, cmake orderonly dependency

080bc90  Merge branch 't/24662/public/scipoptsuite' into t/21003/pyscipopt

comment:32 Changed 3 years ago by
in the meantime its version 1.4.4: I am on it...
comment:33 Changed 3 years ago by
 Branch changed from u/mkoeppe/pyscipopt to u/moritz/pyscipopt
comment:34 Changed 3 years ago by
 Commit changed from 080bc9037c475123d4ed1428150d740d64480001 to 82fd6d6f0ef30160e00a794cb339b78170ef9bf7
I marked all doctest optional
and updated.
Suddenly, one doctest doesn't work anymore:
sage: g = graphs.CubeGraph(9) sage: p = MixedIntegerLinearProgram(solver = "SCIP") # optional  pyscipopt sage: b = p.new_variable(binary=True) # optional  pyscipopt sage: p.set_objective(p.sum(b[v] for v in g)) # optional  pyscipopt sage: for v in g: # optional  pyscipopt ....: p.add_constraint(b[v]+p.sum(b[u] for u in g.neighbors(v)) <= 1) # optional  pyscipopt sage: p.add_constraint(b[v] == 1) # Force an easy non0 solution # optional  pyscipopt sage: p.solver_parameter("limits/absgap", 100) # optional  pyscipopt sage: p.solve() # rel tol 100 # optional  pyscipopt
and totaly chrashes sage with an error message free(): invalid pointer
. I don't quite know what is going on.
What is really weird is that it works if I don't run the last line, but instead:
sage: q = copy(p) sage: q.solver_parameter("limits/absgap", 100) sage: q.solve() 0
(I temperarily change 9
to 4
in the doctest above, in order to be able to run the rest of the doctest. The current branch works without failures for me.)
Last 10 new commits:
0544b25  almost all doctests working, some pyscipopt patches

c774d7e  getParam and setParam working

41f641b  all methods implemented in backend; all doctests working

c10594c  one more patch

c7eee88  pyscipopt: update to v1.4.3

a054b24  pyscipopt: update to v1.4.4

3e5621a  scipbackend: added '# optional  pyscipopt'

52b98d0  Make bliss and MP_LIBRARY dependencies, cmake orderonly dependency

f217970  quicksum and modify doctests

82fd6d6  remove all patches

comment:35 Changed 3 years ago by
... the nice thing: all my patches have been merged by a very responsive upstream!
comment:36 Changed 3 years ago by
 Description modified (diff)
comment:37 Changed 3 years ago by
 Description modified (diff)
comment:38 Changed 3 years ago by
 Commit changed from 82fd6d6f0ef30160e00a794cb339b78170ef9bf7 to 8af6e7f53004ab54d17305f2c23ba25425089487
Branch pushed to git repo; I updated commit sha1. This was a forced push. Last 10 new commits:
07a8254  almost all doctests working, some pyscipopt patches

9206579  getParam and setParam working

60b470f  all methods implemented in backend; all doctests working

ccaae73  one more patch

c0bc9d2  pyscipopt: update to v1.4.3

04f33d1  pyscipopt: update to v1.4.4

3816595  scipbackend: added '# optional  pyscipopt'

563e0aa  quicksum and modify doctests

59d8529  remove all patches

8af6e7f  change 4 back to 9

comment:39 Changed 3 years ago by
 Commit changed from 8af6e7f53004ab54d17305f2c23ba25425089487 to c82646a9948757fd4ae193cd4379565e4c275d52
Branch pushed to git repo; I updated commit sha1. This was a forced push. Last 10 new commits:
670146b  almost all doctests working, some pyscipopt patches

cfbbdb1  getParam and setParam working

9d66f70  all methods implemented in backend; all doctests working

2b6efc9  one more patch

d246de5  pyscipopt: update to v1.4.3

b431129  pyscipopt: update to v1.4.4

1f9050d  scipbackend: added '# optional  pyscipopt'

95890af  quicksum and modify doctests

6c7d9c9  remove all patches

c82646a  change 4 back to 9

comment:40 Changed 3 years ago by
 Reviewers set to Moritz Firsching
 Status changed from needs_work to needs_review
now everything seems to work! I reviewed the stubs and everything written by Matthias on this ticket.
comment:41 Changed 3 years ago by
 Status changed from needs_review to needs_work
In the spkginstall
script you should not be using the make
command but rather sdh_make
from the "Sagedistribution helper" tools (see src/bin/sagedisthelpers
).
comment:42 Changed 3 years ago by
Also avoid $MAKE test  tee testsuite.log
(in spkgcheck
). It is not the role of the script to perform redirections.
comment:43 followup: ↓ 45 Changed 3 years ago by
Thanks for the comments, Vincent! I assume, they are meant for the scipoptsuite package, not the pyscipopt one, I will change that on #24662..
comment:44 Changed 3 years ago by
Please use multiple lines for
cmake .. DCMAKE_INSTALL_PREFIX="${SAGE_LOCAL}"/ DCMAKE_VERBOSE_MAKEFILE=ON DGMP_DIR="${SAGE_LOCAL}" DZLIB_ROOT="${SAGE_LOCAL}" DReadline_ROOT_DIR="${SAGE_LOCAL}" DBLISS_DIR="${SAGE_LOCAL}" DIPOPT=FALSE
comment:45 in reply to: ↑ 43 ; followup: ↓ 46 Changed 3 years ago by
comment:46 in reply to: ↑ 45 Changed 3 years ago by
Replying to vdelecroix:
Replying to moritz:
Thanks for the comments, Vincent! I assume, they are meant for the scipoptsuite package, not the pyscipopt one, I will change that on #24662..
You should not, this ticket is in positive review!
ok
comment:47 Changed 3 years ago by
Why this change in numerical/mip.pyx
 self._p._backend.set_variable_type(j, self._vtype) + #self._p._backend.set_variable_type(j, self._vtype)
If this line is not needed anymore just remove it.
comment:48 Changed 3 years ago by
You could also simplify the SPKG.txt
file:
 the section
SPKG Maintainers
of SPKG.txt is not needed anymore (the information is likely to be not up to date in few time)  if
Special Update/Build Instructions
is empty, just avoid it.
comment:49 Changed 3 years ago by
 Commit changed from c82646a9948757fd4ae193cd4379565e4c275d52 to 31e0d1fec4e8547f0d2c08e4932b39c21d788508
Branch pushed to git repo; I updated commit sha1. This was a forced push. Last 10 new commits:
c3bc320  getParam and setParam working

c4c3680  all methods implemented in backend; all doctests working

d3aa9d0  one more patch

e9f531e  pyscipopt: update to v1.4.3

0a07d61  pyscipopt: update to v1.4.4

de6b1bf  scipbackend: added '# optional  pyscipopt'

fba294a  quicksum and modify doctests

4aadef8  remove all patches

94fac2d  change 4 back to 9

31e0d1f  rebased and Vincent's suggestions

comment:50 Changed 3 years ago by
 Commit changed from 31e0d1fec4e8547f0d2c08e4932b39c21d788508 to c0b432c427236c07f76f930a156a15d3f33eb1f1
Branch pushed to git repo; I updated commit sha1. New commits:
c0b432c  correct linebreaks

comment:51 Changed 3 years ago by
 Status changed from needs_work to needs_review
I addressed all suggestions by Vincent and tested the install of scipoptsuite as well as pyscipopt.
comment:52 followup: ↓ 57 Changed 3 years ago by
 Milestone changed from sage8.2 to sage8.3
 Reviewers changed from Moritz Firsching to Moritz Firsching, Vincent Delecroix
 Status changed from needs_review to needs_work
merge conflicts
comment:53 Changed 3 years ago by
And this will not work
cmake .. DCMAKE_INSTALL_PREFIX="${SAGE_LOCAL}"/ DCMAKE_VERBOSE_MAKEFILE=ON DGMP_DIR="${SAGE_LOCAL}" DZLIB_ROOT="${SAGE_LOCAL}" DReadline_ROOT_DIR="${SAGE_LOCAL}" DBLISS_DIR="${SAGE_LOCAL}" DIPOPT=FALSE
You need to add backslashes for line continuation
cmake .. DCMAKE_INSTALL_PREFIX="${SAGE_LOCAL}" \ DCMAKE_VERBOSE_MAKEFILE=ON \ DGMP_DIR="${SAGE_LOCAL}" \ DZLIB_ROOT="${SAGE_LOCAL}" \ DReadline_ROOT_DIR="${SAGE_LOCAL}" \ DBLISS_DIR="${SAGE_LOCAL}" \ DIPOPT=FALSE
comment:54 Changed 3 years ago by
I will get to work. I think the line break issue was fixed here: https://git.sagemath.org/sage.git/commit/?id=c0b432c427236c07f76f930a156a15d3f33eb1f1
But I can make the slashes align, of course.
comment:55 Changed 3 years ago by
Alignment does not matter. But there should be backslashes.
comment:56 Changed 3 years ago by
 Commit changed from c0b432c427236c07f76f930a156a15d3f33eb1f1 to c07eb7ed461c58b1c353c7518566a1c7e7ec7e35
Branch pushed to git repo; I updated commit sha1. This was a forced push. Last 10 new commits:
3c7d354  all methods implemented in backend; all doctests working

e9095b7  one more patch

f33a55e  pyscipopt: update to v1.4.3

99c5010  pyscipopt: update to v1.4.4

78ef11d  scipbackend: added '# optional  pyscipopt'

e59e041  quicksum and modify doctests

24ca41d  remove all patches

d627bcd  change 4 back to 9

10913f8  rebased and Vincent's suggestions

c07eb7e  correct linebreaks

comment:57 in reply to: ↑ 52 ; followup: ↓ 58 Changed 3 years ago by
 Status changed from needs_work to needs_review
Replying to vdelecroix:
merge conflicts
I did a rebase, and it was done automatically. I ran all the tests, and (at least on my machine) everything works..
I am a bit confused, because I expected to see merge conflicts..
comment:58 in reply to: ↑ 57 Changed 3 years ago by
Replying to moritz:
Replying to vdelecroix:
merge conflicts
I did a rebase, and it was done automatically. I ran all the tests, and (at least on my machine) everything works..
I am a bit confused, because I expected to see merge conflicts..
Applying patches is not commutative!
comment:59 followup: ↓ 61 Changed 3 years ago by
What is the point of using Cython here? Because you use pyscipopt
everywhere there is no C at all in the file scip_backend.pyx
. I would keep it simple and use pure python here.
comment:60 Changed 3 years ago by
 Status changed from needs_review to needs_info
comment:61 in reply to: ↑ 59 ; followups: ↓ 62 ↓ 63 Changed 3 years ago by
Replying to vdelecroix:
What is the point of using Cython here? Because you use
pyscipopt
everywhere there is no C at all in the filescip_backend.pyx
. I would keep it simple and use pure python here.
I think Matthias made the backend Cython, because the generic_backend.pyx
is also written this way and all the other files are written in this way. However other backends might actually need this.
I agree that there we don't really need Cython for the pyscipopt backend. But it doesn't do any harm, does it? I am indifferent; we can change it or leave it, both is fine with me.
comment:62 in reply to: ↑ 61 Changed 3 years ago by
Replying to moritz:
Replying to vdelecroix:
What is the point of using Cython here? Because you use
pyscipopt
everywhere there is no C at all in the filescip_backend.pyx
. I would keep it simple and use pure python here.I think Matthias made the backend Cython, because the
generic_backend.pyx
is also written this way and all the other files are written in this way. However other backends might actually need this.I agree that there we don't really need Cython for the pyscipopt backend. But it doesn't do any harm, does it? I am indifferent; we can change it or leave it, both is fine with me.
On the plus side
 do like the other backends
On the minus side
 two files (pxd/pyx) instead of one
 longer compilation time
 more delicate to debug
The reason why all other backends are written in Cython is because they do call C functions.
comment:63 in reply to: ↑ 61 Changed 3 years ago by
Replying to moritz:
I think Matthias made the backend Cython, because the
generic_backend.pyx
is also written this way and all the other files are written in this way.
That's correct, I did this just for copypastability and no technical reason otherwise.
comment:64 Changed 3 years ago by
 Commit changed from c07eb7ed461c58b1c353c7518566a1c7e7ec7e35 to ae0bab040a3b6d0cb77c5593bf486242365621f6
Branch pushed to git repo; I updated commit sha1. This was a forced push. Last 10 new commits:
0e30cca  pyscipopt: update to v1.4.3

7e112c8  pyscipopt: update to v1.4.4

d1519b9  scipbackend: added '# optional  pyscipopt'

901f8cf  quicksum and modify doctests

8fc35cf  remove all patches

32884a0  change 4 back to 9

0ef22c6  rebased and Vincent's suggestions

d23ed3e  correct linebreaks

1cefe04  towards uncythening the scip backend

ae0bab0  decythonizing finished

comment:65 Changed 3 years ago by
Another update to SCIPoptsuite 6.0 is due
comment:66 Changed 3 years ago by
 Milestone changed from sage8.3 to sage8.4
milestone update 8.3 > 8.4
comment:67 Changed 8 months ago by
 Branch changed from u/moritz/pyscipopt to u/mkoeppe/pyscipopt
comment:68 Changed 8 months ago by
 Branch changed from u/mkoeppe/pyscipopt to u/moritz/pyscipopt
 Dependencies changed from #22557, #24662 to #31329
 Milestone changed from sage8.4 to sage9.3
 Status changed from needs_info to needs_work
Squashed/rebased onto #31329 (Update scipoptsuite to 7.0.2)
comment:69 Changed 8 months ago by
 Branch changed from u/moritz/pyscipopt to u/mkoeppe/pyscipopt
comment:70 Changed 8 months ago by
 Commit changed from ae0bab040a3b6d0cb77c5593bf486242365621f6 to cd0b761b3061010bfabe2c71195f2d804fb8a4e5
Branch pushed to git repo; I updated commit sha1. New commits:
cd0b761  build/pkgs/pyscipopt: Update to 3.1.0, update metadata format

comment:71 Changed 8 months ago by
sage: from pyscipopt import Model  ImportError Traceback (most recent call last) <ipythoninput1fcc6f2f967b1> in <module> > 1 from pyscipopt import Model ~/s/sage/sagerebasing/worktreealgebraic2018spring/local/lib/python3.9/sitepackages/pyscipopt/__init__.py in <module> 9 # export userrelevant objects: 10 from pyscipopt.Multidict import multidict > 11 from pyscipopt.scip import Model 12 from pyscipopt.scip import Benders 13 from pyscipopt.scip import Benderscut ImportError: dlopen(/Users/mkoeppe/s/sage/sagerebasing/worktreealgebraic2018spring/local/lib/python3.9/sitepackages/pyscipopt/scip.cpython39darwin.so, 2): Library not loaded: libscip.7.0.dylib Referenced from: /Users/mkoeppe/s/sage/sagerebasing/worktreealgebraic2018spring/local/lib/python3.9/sitepackages/pyscipopt/scip.cpython39darwin.so Reason: image not found
comment:72 Changed 8 months ago by
 Description modified (diff)
comment:73 Changed 6 months ago by
 Milestone changed from sage9.3 to sage9.4
Setting new milestone based on a cursory review of ticket status, priority, and last modification date.
comment:74 Changed 2 months ago by
 Milestone changed from sage9.4 to sage9.5
Setting a new milestone for this ticket based on a cursory review.
Branch pushed to git repo; I updated commit sha1. New commits:
Pacth SCIP Makefile more to get library dependencies right
Fixup
Fixup
Merge branch 't/21094/sage_package_for_scip_integer_programming_solver' into t/21003/pyscipopt