qiskit-machine-learning
Advanced tools
Qiskit Machine Learning: A library of quantum computing machine learning experiments
Qiskit Machine Learning introduces fundamental computational building blocks, such as Quantum Kernels and Quantum Neural Networks, used in various applications including classification and regression.
This library is part of the Qiskit Community ecosystem, a collection of high-level codes that are based
on the Qiskit software development kit. As of version 0.7, Qiskit Machine Learning is co-maintained
by IBM and the Hartree Center, part of the UK Science and
Technologies Facilities Council (STFC).
The Qiskit Machine Learning framework aims to be:
The FidelityQuantumKernel
class uses the Fidelity)
algorithm. It computes kernel matrices for datasets and can be combined with a Quantum Support Vector Classifier (QSVC)
or a Quantum Support Vector Regressor (QSVR)
to solve classification or regression problems respectively. It is also compatible with classical kernel-based machine learning algorithms.
Qiskit Machine Learning defines a generic interface for neural networks, implemented by two core (derived) primitives:
EstimatorQNN: Leverages the Estimator primitive, combining parametrized quantum circuits with quantum mechanical observables. The output is the expected value of the observable.
SamplerQNN: Leverages the Sampler primitive, translating bit-string counts into the desired outputs.
To train and use neural networks, Qiskit Machine Learning provides learning algorithms such as the NeuralNetworkClassifier
and NeuralNetworkRegressor.
Finally, built on these, the Variational Quantum Classifier (VQC)
and the Variational Quantum Regressor (VQR)
take a feature map and an ansatz to construct the underlying QNN automatically using high-level syntax.
The TorchConnector
integrates QNNs with PyTorch.
Thanks to the gradient algorithms in Qiskit Machine Learning, this includes automatic differentiation.
The overall gradients computed by PyTorch during the backpropagation take into account quantum neural
networks, too. The flexible design also allows the building of connectors to other packages in the future.
We encourage installing Qiskit Machine Learning via the pip tool, a Python package manager.
pip install qiskit-machine-learning
pip will install all dependencies automatically, so that you will always have the most recent
stable version.
If you want to work instead on the very latest work-in-progress versions of Qiskit Machine Learning, either to try features ahead of their official release or if you want to contribute to the library, then you can install from source. For more details on how to do so and much more, follow the instructions in the documentation.
PyTorch may be installed either using command pip install 'qiskit-machine-learning[torch]' to install the
package or refer to PyTorch getting started. When PyTorch
is installed, the TorchConnector facilitates its use of quantum computed networks.
Sparse may be installed using command pip install 'qiskit-machine-learning[sparse]' to install the
package. Sparse being installed will enable the usage of sparse arrays and tensors.
NLopt is required for the global optimizers. NLopt
can be installed manually with pip install nlopt on Windows and Linux platforms, or with brew install nlopt on MacOS using the Homebrew package manager. For more information,
refer to the installation guide.
[!NOTE] Qiskit Machine Learning depends on Qiskit, which will be automatically installed as a dependency when you install Qiskit Machine Learning. From version
0.8of Qiskit Machine Learning, Qiskit1.0or above will be required. If you have a pre-1.0version of Qiskit installed in your environment (however it was installed), you should upgrade to1.xto continue using the latest features. You may refer to the official Qiskit 1.0 Migration Guide for detailed instructions and examples on how to upgrade Qiskit.
Now that Qiskit Machine Learning is installed, it's time to begin working with the Machine Learning module. Let's try an experiment using VQC (Variational Quantum Classifier) algorithm to train and test samples from a data set to see how accurately the test set can be classified.
from qiskit.circuit.library import TwoLocal, ZZFeatureMap
from qiskit_machine_learning.optimizers import COBYLA
from qiskit_machine_learning.utils import algorithm_globals
from qiskit_machine_learning.algorithms import VQC
from qiskit_machine_learning.datasets import ad_hoc_data
seed = 1376
algorithm_globals.random_seed = seed
# Use ad hoc data set for training and test data
feature_dim = 2 # dimension of each data point
training_size = 20
test_size = 10
# training features, training labels, test features, test labels as np.ndarray,
# one hot encoding for labels
training_features, training_labels, test_features, test_labels = ad_hoc_data(
training_size=training_size, test_size=test_size, n=feature_dim, gap=0.3
)
feature_map = ZZFeatureMap(feature_dimension=feature_dim, reps=2, entanglement="linear")
ansatz = TwoLocal(feature_map.num_qubits, ["ry", "rz"], "cz", reps=3)
vqc = VQC(
feature_map=feature_map,
ansatz=ansatz,
optimizer=COBYLA(maxiter=100),
)
vqc.fit(training_features, training_labels)
score = vqc.score(test_features, test_labels)
print(f"Testing accuracy: {score:0.2f}")
Learning path notebooks may be found in the Machine Learning tutorials section of the documentation and are a great place to start.
Another good place to learn the fundamentals of quantum machine learning is the Quantum Machine Learning notebooks from the original Qiskit Textbook. The notebooks are convenient for beginners who are eager to learn quantum machine learning from scratch, as well as understand the background and theory behind algorithms in Qiskit Machine Learning. The notebooks cover a variety of topics to build understanding of parameterized circuits, data encoding, variational algorithms etc., and in the end the ultimate goal of machine learning - how to build and train quantum ML models for supervised and unsupervised learning. The Textbook notebooks are complementary to the tutorials of this module; whereas these tutorials focus on actual Qiskit Machine Learning algorithms, the Textbook notebooks more explain and detail underlying fundamentals of quantum machine learning.
If you'd like to contribute to Qiskit, please take a look at our contribution guidelines. This project adheres to the Qiskit code of conduct. By participating, you are expected to uphold this code.
We use GitHub issues for tracking requests and bugs. Please
join the Qiskit Slack community
and use the #qiskit-machine-learning
channel for discussions and short questions.
For questions that are more suited for a forum, you can use the Qiskit tag in Stack Overflow.
Qiskit Machine Learning was inspired, authored and brought about by the collective work of a team of researchers and software engineers. This library 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.
FAQs
Qiskit Machine Learning: A library of quantum computing machine learning experiments
We found that qiskit-machine-learning demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.