An addon for optimization problem modeling, providing various utilities and enhancements.
Project description
Qiskit addon: optimization modeling
Table of contents
- About
- Documentation
- Installation
- Computational requirements
- Deprecation Policy
- Contributing
- License
- References
About
Qiskit addons are a collection of modular tools for building utility-scale workloads powered by Qiskit.
This package contains the Qiskit addon for optimization modeling. Quantum computers have the potential to solve combinatorial optimization problems [1]. These optimization problems can be formulated in an abstract model and then converted into a representation that a quantum computer can understand, for instance a Hamiltonian operator.
The optimization workflow first involves formulating the optimization problem in mathematical terms. This requires defining the objective function to either maximize or minimize and adding any constraints that the decision variables must satisfy. The variables may be continuous, integare, binary or spin-like. Furthermore, the constraints on the variables are typically formulated as equalities and inequalities. Second, this mathematical model is often reformulated into an unconstrained form by transforming the constraints into penalty terms. Third, the decision variables may be converted into a desired format. For example, integer variables may the transformed into binary variables so that the resulting model is either quadratic unconstrained binary optimization (QUBO) problem or a higher-order unconstrained binary optimization (HUBO) problem. In this package the term higher-order is used to designed any polynomial or monomial with a degree higher than two. Finally, the model is translated into a format that a quantum computer can understand. Typically, this implies creating a Hamiltonian operator whose ground state corresponds to the solution of the original optimization problem.
Documentation
All documentation is available at https://qiskit.github.io/qiskit-addon-opt-mapper
Installation
We encourage installing this package via pip, when possible:
pip install qiskit-addon-opt-mapper
For more installation information refer to these installation instructions.
Computational requirements
The most computationally expensive part of the addon is the computation of the objective function for large combinatorial optimization problems.
Deprecation Policy
We follow semantic versioning and are guided by the principles in Qiskit's deprecation policy. We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the release notes.
Contributing
The source code is available on GitHub.
The developer guide is located at CONTRIBUTING.md in the root of this project's repository. By participating, you are expected to uphold Qiskit's code of conduct.
We use GitHub issues for tracking requests and bugs.
License
References
[1] Abbas, et al. Challenges and opportunities in quantum optimization, Nat. Rev. Physics 6, 718-735 (2024).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file qiskit_addon_opt_mapper-0.1.0.tar.gz.
File metadata
- Download URL: qiskit_addon_opt_mapper-0.1.0.tar.gz
- Upload date:
- Size: 204.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3a9e4e2a5579d100579d05d8ae59a4cf4ef33493df287593114daa008890d624
|
|
| MD5 |
deb3b3b13d38949ad1fdbbc43f885134
|
|
| BLAKE2b-256 |
e6232221fef90651791c2b9c136a0059e302782b69ff0002bf292c7222ec74a3
|
Provenance
The following attestation bundles were made for qiskit_addon_opt_mapper-0.1.0.tar.gz:
Publisher:
release.yml on Qiskit/qiskit-addon-opt-mapper
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
qiskit_addon_opt_mapper-0.1.0.tar.gz -
Subject digest:
3a9e4e2a5579d100579d05d8ae59a4cf4ef33493df287593114daa008890d624 - Sigstore transparency entry: 662674548
- Sigstore integration time:
-
Permalink:
Qiskit/qiskit-addon-opt-mapper@dfcfabf8cc4cfd850b3a3b1240090f57962572c1 -
Branch / Tag:
refs/tags/0.1.0 - Owner: https://github.com/Qiskit
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@dfcfabf8cc4cfd850b3a3b1240090f57962572c1 -
Trigger Event:
push
-
Statement type:
File details
Details for the file qiskit_addon_opt_mapper-0.1.0-py3-none-any.whl.
File metadata
- Download URL: qiskit_addon_opt_mapper-0.1.0-py3-none-any.whl
- Upload date:
- Size: 127.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5cc070c7ba5dc9f5e0289a142147cfcdc52f90cde5fe8c44fc62de1181cb096c
|
|
| MD5 |
e591397078c8f5d9180814fa38e87f14
|
|
| BLAKE2b-256 |
986f1ca962bb1800d43bd22a5095c81d2a51c634e5e40399e4942e0d6235a074
|
Provenance
The following attestation bundles were made for qiskit_addon_opt_mapper-0.1.0-py3-none-any.whl:
Publisher:
release.yml on Qiskit/qiskit-addon-opt-mapper
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
qiskit_addon_opt_mapper-0.1.0-py3-none-any.whl -
Subject digest:
5cc070c7ba5dc9f5e0289a142147cfcdc52f90cde5fe8c44fc62de1181cb096c - Sigstore transparency entry: 662674552
- Sigstore integration time:
-
Permalink:
Qiskit/qiskit-addon-opt-mapper@dfcfabf8cc4cfd850b3a3b1240090f57962572c1 -
Branch / Tag:
refs/tags/0.1.0 - Owner: https://github.com/Qiskit
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@dfcfabf8cc4cfd850b3a3b1240090f57962572c1 -
Trigger Event:
push
-
Statement type: