Adds translators between modeling libraries and quadratic program

.pylintdict

@@ -110,6 +110,7 @@ nosignatures
 np
 num
 numpy
+october
 optimality
 optimizationresult
 optimizationresultstatus

docs/tutorials/01_quadratic_program.ipynb

@@ -55,7 +55,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from qiskit_optimization import QuadraticProgram"
+    "from qiskit_optimization import QuadraticProgram\n",
+    "from qiskit_optimization.translators import from_docplex_mp"
    ]
   },
   {
@@ -72,7 +73,7 @@
     "Qiskit's optimization module supports the conversion from Docplex model. You can easily make a model of an optimization problem with Docplex.\n",
     "You can find the documentation of Docplex at https://ibmdecisionoptimization.github.io/docplex-doc/mp/index.html\n",
     "\n",
-    "You can load a Docplex model to `QuadraticProgram` by invoking `from_docplex`."
+    "You can load a Docplex model to `QuadraticProgram` by using `from_docplex_mp` function."
    ]
   },
   {
@@ -167,8 +168,7 @@
    ],
    "source": [
     "# load from a Docplex model\n",
-    "mod = QuadraticProgram()\n",
-    "mod.from_docplex(mdl)\n",
+    "mod = from_docplex_mp(mdl)\n",
     "print(mod.export_as_lp_string())"
    ]
   },
@@ -821,4 +821,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}

docs/tutorials/04_grover_optimizer.ipynb

@@ -69,7 +69,7 @@
     "\\min_{x \\in \\{0, 1\\}^3} -2x_1x_3 - x_2x_3 - 1x_1 + 2x_2 - 3x_3.\n",
     "\\end{eqnarray}\n",
     "\n",
-    "For our initial steps, we create a docplex model that defines the problem above, and then use the ```from_docplex()``` function to convert the model to a ```QuadraticProgram```, which can be used to represent a QUBO in Qiskit Optimization."
+    "For our initial steps, we create a docplex model that defines the problem above, and then use the ```from_docplex_mp()``` function to convert the model to a ```QuadraticProgram```, which can be used to represent a QUBO in Qiskit Optimization."
    ]
   },
   {
@@ -81,6 +81,7 @@
     "from qiskit.algorithms import NumPyMinimumEigensolver\n",
     "from qiskit_optimization.algorithms import GroverOptimizer, MinimumEigenOptimizer\n",
     "from qiskit_optimization.problems import QuadraticProgram\n",
+    "from qiskit_optimization.translators import from_docplex_mp\n",
     "from qiskit import BasicAer\n",
     "from docplex.mp.model import Model\n",
     "\n",
@@ -124,8 +125,7 @@
     "x1 = model.binary_var(name='x1')\n",
     "x2 = model.binary_var(name='x2')\n",
     "model.minimize(-x0+2*x1-3*x2-2*x0*x2-1*x1*x2)\n",
-    "qp = QuadraticProgram()\n",
-    "qp.from_docplex(model)\n",
+    "qp = from_docplex_mp(model)\n",
     "print(qp.export_as_lp_string())"
    ]
   },
@@ -312,4 +312,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}

docs/tutorials/05_admm_optimizer.ipynb

@@ -94,6 +94,7 @@
     "from qiskit_optimization.algorithms import CobylaOptimizer, MinimumEigenOptimizer\n",
     "from qiskit_optimization.problems import QuadraticProgram\n",
     "from qiskit_optimization.algorithms.admm_optimizer import ADMMParameters, ADMMOptimizer\n",
+    "from qiskit_optimization.translators import from_docplex_mp\n",
     "\n",
     "# If CPLEX is installed, you can uncomment this line to import the CplexOptimizer.\n",
     "# CPLEX can be used in this tutorial to solve the convex continuous problem, \n",
@@ -199,8 +200,7 @@
     "mdl.add_constraint(v + w == 1, \"cons3\")\n",
     "\n",
     "# load quadratic program from docplex model\n",
-    "qp = QuadraticProgram()\n",
-    "qp.from_docplex(mdl)\n",
+    "qp = from_docplex_mp(mdl)\n",
     "print(qp.export_as_lp_string())"
    ]
   },
@@ -530,4 +530,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}

docs/tutorials/08_cvar_optimization.ipynb

@@ -35,6 +35,7 @@
     "from qiskit_optimization import QuadraticProgram\n",
     "from qiskit_optimization.converters import LinearEqualityToPenalty\n",
     "from qiskit_optimization.algorithms import MinimumEigenOptimizer\n",
+    "from qiskit_optimization.translators import from_docplex_mp\n",
     "from qiskit import execute, Aer\n",
     "from qiskit.utils import algorithm_globals\n",
     "\n",
@@ -109,8 +110,7 @@
     "mdl.add_constraint(mdl.sum(x[i] for i in range(n)) == budget)\n",
     "\n",
     "# case to \n",
-    "qp = QuadraticProgram()\n",
-    "qp.from_docplex(mdl)"
+    "qp = from_docplex_mp(mdl)"
    ]
   },
   {
@@ -384,4 +384,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}

docs/tutorials/10_warm_start_qaoa.ipynb

@@ -51,7 +51,8 @@
     "from qiskit_optimization.algorithms import MinimumEigenOptimizer, CplexOptimizer\n",
     "from qiskit_optimization import QuadraticProgram\n",
     "from qiskit_optimization.problems.variable import VarType\n",
-    "from qiskit_optimization.converters.quadratic_program_to_qubo import QuadraticProgramToQubo"
+    "from qiskit_optimization.converters.quadratic_program_to_qubo import QuadraticProgramToQubo\n",
+    "from qiskit_optimization.translators import from_docplex_mp"
    ]
   },
   {
@@ -83,9 +84,7 @@
     "    cost = mdl.sum(x)\n",
     "    mdl.add_constraint(cost == total)\n",
     "    \n",
-    "    qp = QuadraticProgram()\n",
-    "    qp.from_docplex(mdl)\n",
-    "    \n",
+    "    qp = from_docplex_mp(mdl)\n",
     "    return qp\n",
     "\n",
     "def relax_problem(problem) -> QuadraticProgram:\n",
@@ -758,4 +757,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}

qiskit_optimization/algorithms/cplex_optimizer.py

@@ -18,12 +18,13 @@
 
 from qiskit.exceptions import MissingOptionalLibraryError
 
+from qiskit_optimization.problems.quadratic_program import QuadraticProgram
+from qiskit_optimization.translators import to_docplex_mp
 from .optimization_algorithm import (
     OptimizationAlgorithm,
     OptimizationResult,
     OptimizationResultStatus,
 )
-from ..problems.quadratic_program import QuadraticProgram
 
 logger = logging.getLogger(__name__)
 
@@ -139,7 +140,7 @@ def solve(self, problem: QuadraticProgram) -> OptimizationResult:
             QiskitOptimizationError: If the problem is incompatible with the optimizer.
         """
 
-        mod = problem.to_docplex()
+        mod = to_docplex_mp(problem)
         sol = mod.solve(log_output=self._disp, cplex_parameters=self._cplex_parameters)
         if sol is None:
             # no solution is found

qiskit_optimization/algorithms/gurobi_optimizer.py

@@ -15,9 +15,11 @@
 import logging
 
 from qiskit.exceptions import MissingOptionalLibraryError
-from .optimization_algorithm import OptimizationAlgorithm, OptimizationResult
+
 from ..exceptions import QiskitOptimizationError
 from ..problems.quadratic_program import QuadraticProgram
+from ..translators.gurobipy import to_gurobipy
+from .optimization_algorithm import OptimizationAlgorithm, OptimizationResult
 
 logger = logging.getLogger(__name__)
 
@@ -32,7 +34,7 @@
 class GurobiOptimizer(OptimizationAlgorithm):
     """The Gurobi optimizer wrapped as an Qiskit :class:`OptimizationAlgorithm`.
 
-    This class provides a wrapper for ``gurobipy`` (https://pypi.gurobi.com)
+    This class provides a wrapper for ``gurobipy``
     to be used within the optimization module.
 
     Examples:
@@ -63,7 +65,7 @@ def __init__(self, disp: bool = False) -> None:
             raise MissingOptionalLibraryError(
                 libname="GUROBI",
                 name="GurobiOptimizer",
-                pip_install="pip install -i https://pypi.gurobi.com gurobipy",
+                pip_install="pip install qiskit-optimization[gurobi]",
             )
 
         self._disp = disp
@@ -122,7 +124,7 @@ def solve(self, problem: QuadraticProgram) -> OptimizationResult:
         """
 
         # convert to Gurobi problem
-        model = problem.to_gurobipy()
+        model = to_gurobipy(problem)
 
         # Enable non-convex
         model.Params.NonConvex = 2

qiskit_optimization/applications/clique.py

@@ -19,6 +19,7 @@
 
 from qiskit_optimization.algorithms import OptimizationResult
 from qiskit_optimization.problems.quadratic_program import QuadraticProgram
+from qiskit_optimization.translators import from_docplex_mp
 from .graph_optimization_application import GraphOptimizationApplication
 
 
@@ -64,8 +65,7 @@ def to_quadratic_program(self) -> QuadraticProgram:
             mdl.maximize(mdl.sum(x[i] for i in x))
         else:
             mdl.add_constraint(mdl.sum(x[i] for i in x) == self.size)
-        op = QuadraticProgram()
-        op.from_docplex(mdl)
+        op = from_docplex_mp(mdl)
         return op
 
     def interpret(self, result: Union[OptimizationResult, np.ndarray]) -> List[int]:

qiskit_optimization/applications/exact_cover.py

@@ -18,6 +18,7 @@
 
 from qiskit_optimization.algorithms import OptimizationResult
 from qiskit_optimization.problems.quadratic_program import QuadraticProgram
+from qiskit_optimization.translators import from_docplex_mp
 from .optimization_application import OptimizationApplication
 
 
@@ -55,8 +56,7 @@ def to_quadratic_program(self) -> QuadraticProgram:
             mdl.add_constraint(
                 mdl.sum(x[i] for i, sub in enumerate(self._subsets) if element in sub) == 1
             )
-        op = QuadraticProgram()
-        op.from_docplex(mdl)
+        op = from_docplex_mp(mdl)
         return op
 
     def interpret(self, result: Union[OptimizationResult, np.ndarray]) -> List[List[int]]:

qiskit_optimization/applications/graph_partition.py

@@ -20,6 +20,7 @@
 
 from qiskit_optimization.algorithms import OptimizationResult
 from qiskit_optimization.problems.quadratic_program import QuadraticProgram
+from qiskit_optimization.translators import from_docplex_mp
 from .graph_optimization_application import GraphOptimizationApplication
 
 
@@ -49,8 +50,7 @@ def to_quadratic_program(self) -> QuadraticProgram:
         )
         mdl.minimize(objective)
         mdl.add_constraint(mdl.sum([x[i] for i in x]) == n // 2)
-        op = QuadraticProgram()
-        op.from_docplex(mdl)
+        op = from_docplex_mp(mdl)
         return op
 
     def interpret(self, result: Union[OptimizationResult, np.ndarray]) -> List[List[int]]:

qiskit_optimization/applications/knapsack.py

@@ -18,6 +18,7 @@
 
 from qiskit_optimization.algorithms import OptimizationResult
 from qiskit_optimization.problems.quadratic_program import QuadraticProgram
+from qiskit_optimization.translators import from_docplex_mp
 from .optimization_application import OptimizationApplication
 
 
@@ -52,8 +53,7 @@ def to_quadratic_program(self) -> QuadraticProgram:
         x = {i: mdl.binary_var(name="x_{0}".format(i)) for i in range(len(self._values))}
         mdl.maximize(mdl.sum(self._values[i] * x[i] for i in x))
         mdl.add_constraint(mdl.sum(self._weights[i] * x[i] for i in x) <= self._max_weight)
-        op = QuadraticProgram()
-        op.from_docplex(mdl)
+        op = from_docplex_mp(mdl)
         return op
 
     def interpret(self, result: Union[OptimizationResult, np.ndarray]) -> List[int]:

qiskit_optimization/applications/max_cut.py

@@ -20,6 +20,7 @@
 
 from qiskit_optimization.algorithms import OptimizationResult
 from qiskit_optimization.problems.quadratic_program import QuadraticProgram
+from qiskit_optimization.translators import from_docplex_mp
 from .graph_optimization_application import GraphOptimizationApplication
 
 
@@ -51,8 +52,7 @@ def to_quadratic_program(self) -> QuadraticProgram:
             for i, j in self._graph.edges
         )
         mdl.maximize(objective)
-        op = QuadraticProgram()
-        op.from_docplex(mdl)
+        op = from_docplex_mp(mdl)
         return op
 
     def _draw_result(

qiskit_optimization/applications/number_partition.py

@@ -19,6 +19,7 @@
 
 from qiskit_optimization.algorithms import OptimizationResult
 from qiskit_optimization.problems.quadratic_program import QuadraticProgram
+from qiskit_optimization.translators import from_docplex_mp
 from .optimization_application import OptimizationApplication
 
 
@@ -50,8 +51,7 @@ def to_quadratic_program(self) -> QuadraticProgram:
         mdl.add_constraint(
             mdl.sum(num * (-2 * x[i] + 1) for i, num in enumerate(self._number_set)) == 0
         )
-        op = QuadraticProgram()
-        op.from_docplex(mdl)
+        op = from_docplex_mp(mdl)
         return op
 
     def interpret(self, result: Union[OptimizationResult, np.ndarray]) -> List[List[int]]:

qiskit_optimization/applications/set_packing.py

@@ -19,6 +19,7 @@
 
 from qiskit_optimization.algorithms import OptimizationResult
 from qiskit_optimization.problems.quadratic_program import QuadraticProgram
+from qiskit_optimization.translators import from_docplex_mp
 from .optimization_application import OptimizationApplication
 
 
@@ -56,8 +57,7 @@ def to_quadratic_program(self) -> QuadraticProgram:
             mdl.add_constraint(
                 mdl.sum(x[i] for i, sub in enumerate(self._subsets) if element in sub) <= 1
             )
-        op = QuadraticProgram()
-        op.from_docplex(mdl)
+        op = from_docplex_mp(mdl)
         return op
 
     def interpret(self, result: Union[OptimizationResult, np.ndarray]) -> List[List[int]]:

qiskit_optimization/applications/stable_set.py

@@ -20,6 +20,7 @@
 
 from qiskit_optimization.algorithms import OptimizationResult
 from qiskit_optimization.problems.quadratic_program import QuadraticProgram
+from qiskit_optimization.translators import from_docplex_mp
 from .graph_optimization_application import GraphOptimizationApplication
 
 
@@ -48,8 +49,7 @@ def to_quadratic_program(self) -> QuadraticProgram:
         for w, v in self._graph.edges:
             mdl.add_constraint(x[w] + x[v] <= 1)
         mdl.maximize(objective)
-        op = QuadraticProgram()
-        op.from_docplex(mdl)
+        op = from_docplex_mp(mdl)
         return op
 
     def interpret(self, result: Union[OptimizationResult, np.ndarray]) -> List[int]:

qiskit_optimization/applications/tsp.py

@@ -18,9 +18,10 @@
 from docplex.mp.model import Model
 
 from qiskit.utils import algorithm_globals
-from ..algorithms import OptimizationResult
-from ..exceptions import QiskitOptimizationError
-from ..problems.quadratic_program import QuadraticProgram
+from qiskit_optimization.algorithms import OptimizationResult
+from qiskit_optimization.exceptions import QiskitOptimizationError
+from qiskit_optimization.problems import QuadraticProgram
+from qiskit_optimization.translators import from_docplex_mp
 from .graph_optimization_application import GraphOptimizationApplication
 
 
@@ -60,8 +61,7 @@ def to_quadratic_program(self) -> QuadraticProgram:
             mdl.add_constraint(mdl.sum(x[(i, k)] for k in range(n)) == 1)
         for k in range(n):
             mdl.add_constraint(mdl.sum(x[(i, k)] for i in range(n)) == 1)
-        op = QuadraticProgram()
-        op.from_docplex(mdl)
+        op = from_docplex_mp(mdl)
         return op
 
     def interpret(