[WIP] Introduce a framework to convert a modeling library to a quadratic program and vice versa by t-imamichi · Pull Request #116 · qiskit-community/qiskit-optimization

t-imamichi · 2021-04-30T07:21:24Z

Summary

It introduces a model translator to convert a modeling libraries (e.g., docplex, gurobipy, etc.) to QuadraticProgram and vice versa.
It adds QuadraticProgram.from_model(model, translator) and QuadraticProgram.to_model(translator) as a generic version of from_docplex and to_docplex.

I revised the design in #122 without gurobipy.

Fixes #80

TODO:

Design discussion
Fix cyclic imports

Details and comments

Removed as per Stefan's comment

CLAassistant · 2021-04-30T07:21:32Z

All committers have signed the CLA.

This reverts commit fb3b8d1.

adekusar-drl · 2021-04-30T14:29:47Z

-    def from_docplex(self, model: Model) -> None:
-        """Loads this quadratic program from a docplex model.


Should we deprecate from_docplex as well as to_docplex?

Yes, I'm ready to add the deprecation warnings as follows.
https://github.com/Qiskit/qiskit-optimization/blob/27e2713873a8575e6b2136a499e29ffe6c3e3109/qiskit_optimization/problems/quadratic_program.py#L850-L852
https://github.com/Qiskit/qiskit-optimization/blob/27e2713873a8575e6b2136a499e29ffe6c3e3109/qiskit_optimization/problems/quadratic_program.py#L864-L866

adekusar-drl · 2021-04-30T15:03:17Z

+    """
+
+    def qp_to_model(self, quadratic_program: Any) -> GurobiModel:


Perhaps quadratic_program is an instance of QuadraticProgram, not Any?

It is impossible to avoid cyclic import by pylint if quadratic_program: QuadraticProgram. If we are allowed to disable pylint cyclic import, I can do it.

Oh, I see the problem now.

adekusar-drl · 2021-04-30T15:05:52Z

+
+        return mdl
+
+    def model_to_qp(self, model: Model, quadratic_program: Any):


We could avoid having a quadratic_program as a method parameter if we made from_model static.
And should we have correct type hints?

Yes, making from_model static is an option.

should just return a QuatraticProgram, doesn't need to be static for that (and I'd keep it non-static, maybe there are cases where we would like to parametrize the translator). Same for GUROBI and interface.

@stefan-woerner I mean QuadraticProgram.from_model() to be static, not the methods in the translators.
I think it should look like: qp = QuadraticProgram.from_model(another_model, translator)

@adekusar-drl thanks, sounds good!

adekusar-drl · 2021-04-30T15:06:53Z

+        if translator is None:
+            from qiskit_optimization.translators.docplex import DocplexTranslator
+            translator = DocplexTranslator()
+        translator.model_to_qp(model, self)


Should we have a translator instance explicitly instead of defaulting to DOcplex?

adekusar-drl · 2021-04-30T15:07:30Z

-    def from_docplex(self, model: Model) -> None:
-        """Loads this quadratic program from a docplex model.
+    def from_model(self, model: Model, translator: Optional[ModelTranslator] = None) -> None:
+        """Loads this quadratic program from an optimization model.


Is model: Model valid? I guess Model here comes from DOcplex? Should it be something more generic?

I suggest to make from_model a static method to be able to create a model like qp = QuadraticProgram.from_model(another_model, translator)

You are right. model: Model is invalid here because Model is docplex.mp.model.Model. I agree to making from_model static.

adekusar-drl · 2021-04-30T15:14:52Z

+    """
+
+    def qp_to_model(self, quadratic_program: Any) -> Any:


Should we have correct type hints?

It is impossible due to pylint outputs cyclic import errors. pylint does not seem to support typing.TYPE_CHECKING. So, I cannot find a way to avoid cyclic import errors except disabling it. Do you have any good idea?

adekusar-drl · 2021-04-30T15:17:48Z

+    """
+
+    @abstractmethod
+    def qp_to_model(self, quadratic_program: Any) -> Any:


Same as above, why quadratic_program: Any, but not quadratic_program: QuadraticProgram ?

adekusar-drl · 2021-04-30T15:20:55Z

+        """
+        pass
+
+    @abstractmethod
+    def model_to_qp(self, model: Any, quadratic_program: Any) -> None:


# Conflicts: # qiskit_optimization/algorithms/__init__.py # qiskit_optimization/applications/max_cut.py # qiskit_optimization/problems/quadratic_program.py # test/problems/test_quadratic_program.py

# Conflicts: # qiskit_optimization/problems/quadratic_program.py

stefan-woerner · 2021-05-26T10:53:13Z

+
+        return mdl
+
+    def model_to_qp(self, model: Model, quadratic_program: Any):


should just return a QuatraticProgram, doesn't need to be static for that (and I'd keep it non-static, maybe there are cases where we would like to parametrize the translator). Same for GUROBI and interface.

stefan-woerner · 2021-05-26T10:53:28Z

+class GurobipyTranslator(ModelTranslator):
+    """Translator between a gurobipy model and a quadratic program"""
+
+    def qp_to_model(self, quadratic_program: Any) -> GurobiModel:


Type hint: quadratic_program be of type QuadraticProgram (see @adekusar-drl's comments on interface and GUROBI as well)

t-imamichi · 2021-06-01T12:15:21Z

Close it to continue discussion at #122

RichardOberdieck and others added 30 commits February 24, 2021 19:56

Adding gurobipy as a solver

7d9c2fa

Adding gurobi and gurobipy to .pylintdict

3155b70

Fixing some unit tests

e9e80fc

Final changes to get tests to run

77dfa98

Changing .pylintrc to ignore gurobi member messages

92d41a2

Delete max_cut.py

4aeb295

Removed as per Stefan's comment

Merge branch 'master' into master

56e7698

Merge branch 'master' into master

5a8a848

Merge branch 'master' into master

2fddf40

Install gurobipy in CI, remove it from setup.py

8c3b97c

fix docs

7fcd591

CI test without gurobipy

19b9e19

Merge branch 'master' into master

552fdac

Add GurobiModel to typehints

0c7f0e5

fix lint

91cb275

Merge branch 'master' into master

7b5f20d

remove gurobipy from requirements.txt

57b1d52

Merge branch 'master' into master

a3a28b3

Merge branch 'master' into master

60912c5

Merge branch 'master' into master

8a31fdd

merge master and fix conflicts

45205d6

Merge branch 'master' into master

b3d1df2

Merge branch 'master' into master

0c44388

Merge branch 'master' into master

d296242

Merge branch 'master' into master

11af069

Merge branch 'master' into master

559885b

Merge branch 'master' into master

a1220b7

Merge branch 'main' into master

40c4494

Merge branch 'main' into master

a7b7673

Merge branch 'main' into master

0d6fcd9

manoelmarques and others added 7 commits April 25, 2021 12:37

Install gurobipy from public pypi

5b94fe2

Merge main, fix conflicts

bc083e8

Use requires_extra_library decorator in unit test

e3a5398

Merge main, fix conflicts

77dc2c3

(wip) translator

c591cb9

(wip) translator

8704f5b

fix lint except cyclic import

0b1c888

t-imamichi changed the title ~~Introduce a framework to convert a modeling library to a quadratic program and vice versa~~ [WIP] Introduce a framework to convert a modeling library to a quadratic program and vice versa Apr 30, 2021

t-imamichi added 5 commits April 30, 2021 16:39

add an empty gurobi class in case not installed

5e69721

fix lint

97cc43d

fix doctest

d2cb055

revert pylintrc

fb3b8d1

Revert "revert pylintrc"

27e2713

This reverts commit fb3b8d1.

t-imamichi requested review from adekusar-drl and stefan-woerner April 30, 2021 10:16

adekusar-drl reviewed Apr 30, 2021

View reviewed changes

t-imamichi and others added 4 commits May 6, 2021 19:30

apply black

6ce27e1

Merge branch 'main' into translator

ccb912f

# Conflicts: # qiskit_optimization/algorithms/__init__.py # qiskit_optimization/applications/max_cut.py # qiskit_optimization/problems/quadratic_program.py # test/problems/test_quadratic_program.py

black -l 100

d05cecb

Merge branch 'main' into translator

cc89df9

# Conflicts: # qiskit_optimization/problems/quadratic_program.py

t-imamichi mentioned this pull request May 10, 2021

Adds translators between modeling libraries and quadratic program #122

Merged

6 tasks

stefan-woerner reviewed May 26, 2021

View reviewed changes

t-imamichi mentioned this pull request May 26, 2021

Interface for Gurobi through the gurobipy API #45

Merged

t-imamichi closed this Jun 1, 2021

t-imamichi deleted the translator branch June 8, 2021 02:24

		def from_docplex(self, model: Model) -> None:
		"""Loads this quadratic program from a docplex model.

		"""

		def qp_to_model(self, quadratic_program: Any) -> GurobiModel:


		return mdl

		def model_to_qp(self, model: Model, quadratic_program: Any):

Conversation

t-imamichi commented Apr 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Details and comments

Uh oh!

CLAassistant commented Apr 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

t-imamichi May 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

t-imamichi commented Jun 1, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

t-imamichi commented Apr 30, 2021 •

edited

Loading

CLAassistant commented Apr 30, 2021 •

edited

Loading

t-imamichi May 3, 2021 •

edited

Loading