Qiskit Optimization: A library for optimization applications using quantum computing
Qiskit Optimization is an open-source framework that covers the whole range from high-level modeling of optimization problems, with automatic conversion of problems to different required representations, to a suite of easy-to-use quantum optimization algorithms that are ready to run on classical simulators, as well as on real quantum devices via Qiskit.
The Optimization module enables easy, efficient modeling of optimization problems using docplex. A uniform interface as well as automatic conversion between different problem representations allows users to solve problems using a large set of algorithms, from variational quantum algorithms, such as the Quantum Approximate Optimization Algorithm QAOA, to Grover Adaptive Search using the GroverOptimizer, leveraging fundamental algorithms provided by Qiskit Algorithms. Furthermore, the modular design of the optimization module allows it to be easily extended and facilitates rapid development and testing of new algorithms. Compatible classical optimizers are also provided for testing, validation, and benchmarking.
We encourage installing Qiskit Optimization via the pip tool (a python package manager).
pip install qiskit-optimization
pip will handle all dependencies automatically and you will always install the latest (and well-tested) version.
If you want to work on the very latest work-in-progress versions, either to try features ahead of their official release or if you want to contribute to Optimization, then you can install from source. To do this follow the instructions in the documentation.
IBM CPLEX may be installed using
pip install 'qiskit-optimization[cplex]'to enable the reading of
LPfiles and the usage of the
CplexOptimizer, wrapper for
cplex.Cplex. Currently there is no python 3.9 version of CPLEX. In this case, the CPLEX install command will have no effect.
CVXPY may be installed using the command
pip install 'qiskit-optimization[cvx]'. CVXPY being installed will enable the usage of the Goemans-Williamson algorithm as an optimizer
Matplotlib may be installed using the command
pip install 'qiskit-optimization[matplotlib]'. Matplotlib being installed will enable the usage of the
drawmethod in the graph optimization application classes.
Gurobipy may be installed using the command
pip install 'qiskit-optimization[gurobi]'. Gurobipy being installed will enable the usage of the GurobiOptimizer.
Creating Your First Optimization Programming Experiment in Qiskit
Now that Qiskit Optimization is installed, it's time to begin working with the optimization module. Let's try an optimization experiment to compute the solution of a Max-Cut. The Max-Cut problem can be formulated as quadratic program, which can be solved using many several different algorithms in Qiskit. In this example, the MinimumEigenOptimizer is employed in combination with the Quantum Approximate Optimization Algorithm (QAOA) as minimum eigensolver routine.
from docplex.mp.model import Model from qiskit_optimization.algorithms import MinimumEigenOptimizer from qiskit_optimization.translators import from_docplex_mp from qiskit.primitives import Sampler from qiskit_algorithms.utils import algorithm_globals from qiskit_algorithms import QAOA from qiskit_algorithms.optimizers import SPSA # Generate a graph of 4 nodes n = 4 edges = [(0, 1, 1.0), (0, 2, 1.0), (0, 3, 1.0), (1, 2, 1.0), (2, 3, 1.0)] # (node_i, node_j, weight) # Formulate the problem as a Docplex model model = Model() # Create n binary variables x = model.binary_var_list(n) # Define the objective function to be maximized model.maximize(model.sum(w * x[i] * (1 - x[j]) + w * (1 - x[i]) * x[j] for i, j, w in edges)) # Fix node 0 to be 1 to break the symmetry of the max-cut solution model.add(x == 1) # Convert the Docplex model into a `QuadraticProgram` object problem = from_docplex_mp(model) # Run quantum algorithm QAOA on qasm simulator seed = 1234 algorithm_globals.random_seed = seed spsa = SPSA(maxiter=250) sampler = Sampler() qaoa = QAOA(sampler=sampler, optimizer=spsa, reps=5) algorithm = MinimumEigenOptimizer(qaoa) result = algorithm.solve(problem) print(result.prettyprint()) # prints solution, x=[1, 0, 1, 0], the cost, fval=4
Learning path notebooks may be found in the optimization tutorials section of the documentation and are a great place to start.
We use GitHub issues for tracking requests and bugs. Please join the Qiskit Slack community and for discussion and simple questions. For questions that are more suited for a forum, we use the Qiskit tag in Stack Overflow.
Authors and Citation
Optimization was inspired, authored and brought about by the collective work of a team of researchers. Optimization continues to grow with the help and work of many people, who contribute to the project at different levels. If you use Qiskit, please cite as per the provided BibTeX file.
This project uses the Apache License 2.0.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for qiskit-optimization-0.6.0.tar.gz
Hashes for qiskit_optimization-0.6.0-py3-none-any.whl