# eigenkit

eigenkit is a provider-neutral quantum computing library by EigenOrbit:
a circuit is defined once and runs on any supported simulator or
quantum processor by changing the `provider=` argument. Install with
`pip install eigenkit`.


## Docs

- [Home](https://docs.kit.eigenorbit.com/index.md)
- [Getting Started](https://docs.kit.eigenorbit.com/getting-started/index.md)
- [Architecture](https://docs.kit.eigenorbit.com/architecture-diagrams/index.md)
- [Use with AI](https://docs.kit.eigenorbit.com/use-with-ai/index.md)
- [Changelog](https://docs.kit.eigenorbit.com/changelog/index.md)

## User Guide

- [Algorithms](https://docs.kit.eigenorbit.com/user-guide/algorithms/index.md)
- [Benchmark](https://docs.kit.eigenorbit.com/user-guide/benchmark/index.md)
- [Quantum Chemistry](https://docs.kit.eigenorbit.com/user-guide/chemistry/index.md)
- [Circuit Builder](https://docs.kit.eigenorbit.com/user-guide/circuit-builder/index.md)
- [Datasets](https://docs.kit.eigenorbit.com/user-guide/datasets/index.md)
- [Encoding](https://docs.kit.eigenorbit.com/user-guide/encoding/index.md)
- [Estimators](https://docs.kit.eigenorbit.com/user-guide/estimators/index.md)
- [Interfaces (numpy and torch)](https://docs.kit.eigenorbit.com/user-guide/interfaces/index.md)
- [Quantum Kernels](https://docs.kit.eigenorbit.com/user-guide/kernels/index.md)
- [Layers](https://docs.kit.eigenorbit.com/user-guide/layers/index.md)
- [Model Persistence (.eigenkit)](https://docs.kit.eigenorbit.com/user-guide/model-persistence/index.md)
- [Observables](https://docs.kit.eigenorbit.com/user-guide/observables/index.md)
- [Optimization](https://docs.kit.eigenorbit.com/user-guide/optimization/index.md)
- [Photonic Circuits (Perceval)](https://docs.kit.eigenorbit.com/user-guide/photonics/index.md)
- [Providers](https://docs.kit.eigenorbit.com/user-guide/providers/index.md)
- [QML](https://docs.kit.eigenorbit.com/user-guide/qml/index.md)
- [QPU and Cloud](https://docs.kit.eigenorbit.com/user-guide/qpu/index.md)
- [Reservoir Computing](https://docs.kit.eigenorbit.com/user-guide/reservoir/index.md)
- [Reuploading](https://docs.kit.eigenorbit.com/user-guide/reuploading/index.md)
- [Variational](https://docs.kit.eigenorbit.com/user-guide/variational/index.md)

## Algorithms Explained

- [Overview](https://docs.kit.eigenorbit.com/algorithms/index.md)
- [HHL: Linear Systems](https://docs.kit.eigenorbit.com/algorithms/hhl/index.md)
- [HQNN: Hybrid Neural Networks](https://docs.kit.eigenorbit.com/algorithms/hqnn/index.md)
- [IQAE: Amplitude Estimation](https://docs.kit.eigenorbit.com/algorithms/iqae/index.md)
- [QAOA: Optimization](https://docs.kit.eigenorbit.com/algorithms/qaoa/index.md)
- [QFT: Quantum Fourier Transform](https://docs.kit.eigenorbit.com/algorithms/qft/index.md)
- [QSVC / QSVR: Quantum Kernels](https://docs.kit.eigenorbit.com/algorithms/qsvc-qsvr/index.md)
- [References](https://docs.kit.eigenorbit.com/algorithms/references/index.md)
- [Quantum Reservoir Computing](https://docs.kit.eigenorbit.com/algorithms/reservoir/index.md)
- [VQE: Ground-State Energies](https://docs.kit.eigenorbit.com/algorithms/vqe/index.md)

## Usage Examples

- [Quantum Classification](https://docs.kit.eigenorbit.com/examples/algorithms-classification/index.md)
- [Quantum Regression and Time Series](https://docs.kit.eigenorbit.com/examples/algorithms-regression/index.md)
- [Basic Circuit](https://docs.kit.eigenorbit.com/examples/basic-circuit/index.md)
- [Benchmark on Iris](https://docs.kit.eigenorbit.com/examples/benchmark-iris/index.md)
- [Breast Cancer HQNC](https://docs.kit.eigenorbit.com/examples/breast-cancer-hqnc/index.md)
- [Concrete Strength HQNR](https://docs.kit.eigenorbit.com/examples/cement-hqnr/index.md)
- [Circles HQNC](https://docs.kit.eigenorbit.com/examples/circles-hqnc/index.md)
- [Generic Estimators](https://docs.kit.eigenorbit.com/examples/generic-estimators/index.md)
- [Linear Systems with HHL](https://docs.kit.eigenorbit.com/examples/hhl-honest/index.md)
- [QSVC HPO on Iris](https://docs.kit.eigenorbit.com/examples/hpo-qsvc-iris/index.md)
- [Hybrid Model](https://docs.kit.eigenorbit.com/examples/hybrid-model/index.md)
- [Layers](https://docs.kit.eigenorbit.com/examples/layers/index.md)
- [Pollution Time Series (HQNR vs RecurrentHQNR)](https://docs.kit.eigenorbit.com/examples/pollution-timeseries-hqnr/index.md)
- [MaxCut with QAOA](https://docs.kit.eigenorbit.com/examples/qaoa-max-cut/index.md)
- [Quantum Reservoir Memory](https://docs.kit.eigenorbit.com/examples/reservoir-memory/index.md)
- [Ground-State Energy with VQE](https://docs.kit.eigenorbit.com/examples/vqe-fermi-hubbard/index.md)

## API Reference

- [SUMMARY](https://docs.kit.eigenorbit.com/api/SUMMARY/index.md)
- [algorithms](https://docs.kit.eigenorbit.com/api/algorithms/index.md)
- [benchmark](https://docs.kit.eigenorbit.com/api/benchmark/index.md)
- [chemistry](https://docs.kit.eigenorbit.com/api/chemistry/index.md)
- [circuit](https://docs.kit.eigenorbit.com/api/circuit/index.md)
- [configs](https://docs.kit.eigenorbit.com/api/configs/index.md)
- [core](https://docs.kit.eigenorbit.com/api/core/index.md)
- [datasets](https://docs.kit.eigenorbit.com/api/datasets/index.md)
- [optimization](https://docs.kit.eigenorbit.com/api/optimization/index.md)
- [photonics](https://docs.kit.eigenorbit.com/api/photonics/index.md)
- [qml](https://docs.kit.eigenorbit.com/api/qml/index.md)
- [reservoir](https://docs.kit.eigenorbit.com/api/reservoir/index.md)
- [torch](https://docs.kit.eigenorbit.com/api/torch/index.md)
- [hhl](https://docs.kit.eigenorbit.com/api/algorithms/hhl/index.md)
- [iqae](https://docs.kit.eigenorbit.com/api/algorithms/iqae/index.md)
- [portfolio_risk](https://docs.kit.eigenorbit.com/api/algorithms/portfolio_risk/index.md)
- [ansatz](https://docs.kit.eigenorbit.com/api/chemistry/ansatz/index.md)
- [exact](https://docs.kit.eigenorbit.com/api/chemistry/exact/index.md)
- [fermion](https://docs.kit.eigenorbit.com/api/chemistry/fermion/index.md)
- [interop](https://docs.kit.eigenorbit.com/api/chemistry/interop/index.md)
- [mappings](https://docs.kit.eigenorbit.com/api/chemistry/mappings/index.md)
- [models](https://docs.kit.eigenorbit.com/api/chemistry/models/index.md)
- [molecule](https://docs.kit.eigenorbit.com/api/chemistry/molecule/index.md)
- [vqe](https://docs.kit.eigenorbit.com/api/chemistry/vqe/index.md)
- [backends](https://docs.kit.eigenorbit.com/api/core/backends/index.md)
- [blocks](https://docs.kit.eigenorbit.com/api/core/blocks/index.md)
- [builder](https://docs.kit.eigenorbit.com/api/core/builder/index.md)
- [circuit](https://docs.kit.eigenorbit.com/api/core/circuit/index.md)
- [draw](https://docs.kit.eigenorbit.com/api/core/draw/index.md)
- [draw_mpl](https://docs.kit.eigenorbit.com/api/core/draw_mpl/index.md)
- [interfaces](https://docs.kit.eigenorbit.com/api/core/interfaces/index.md)
- [ir](https://docs.kit.eigenorbit.com/api/core/ir/index.md)
- [observables](https://docs.kit.eigenorbit.com/api/core/observables/index.md)
- [optimizers](https://docs.kit.eigenorbit.com/api/core/optimizers/index.md)
- [provider](https://docs.kit.eigenorbit.com/api/core/provider/index.md)
- [secret_fields](https://docs.kit.eigenorbit.com/api/core/secret_fields/index.md)
- [solver](https://docs.kit.eigenorbit.com/api/core/solver/index.md)
- [variational](https://docs.kit.eigenorbit.com/api/core/variational/index.md)
- [wire](https://docs.kit.eigenorbit.com/api/core/wire/index.md)
- [braket_backend](https://docs.kit.eigenorbit.com/api/core/backends/braket_backend/index.md)
- [cudaquantum_backend](https://docs.kit.eigenorbit.com/api/core/backends/cudaquantum_backend/index.md)
- [iqm_backend](https://docs.kit.eigenorbit.com/api/core/backends/iqm_backend/index.md)
- [numpy_backend](https://docs.kit.eigenorbit.com/api/core/backends/numpy_backend/index.md)
- [pennylane_backend](https://docs.kit.eigenorbit.com/api/core/backends/pennylane_backend/index.md)
- [qiskit_aer_backend](https://docs.kit.eigenorbit.com/api/core/backends/qiskit_aer_backend/index.md)
- [qiskit_backend](https://docs.kit.eigenorbit.com/api/core/backends/qiskit_backend/index.md)
- [qiskit_runtime_backend](https://docs.kit.eigenorbit.com/api/core/backends/qiskit_runtime_backend/index.md)
- [qsim_backend](https://docs.kit.eigenorbit.com/api/core/backends/qsim_backend/index.md)
- [qulacs_backend](https://docs.kit.eigenorbit.com/api/core/backends/qulacs_backend/index.md)
- [tensorcircuit_backend](https://docs.kit.eigenorbit.com/api/core/backends/tensorcircuit_backend/index.md)
- [eda](https://docs.kit.eigenorbit.com/api/datasets/eda/index.md)
- [problems](https://docs.kit.eigenorbit.com/api/optimization/problems/index.md)
- [qaoa](https://docs.kit.eigenorbit.com/api/optimization/qaoa/index.md)
- [backends](https://docs.kit.eigenorbit.com/api/photonics/backends/index.md)
- [executor](https://docs.kit.eigenorbit.com/api/photonics/executor/index.md)
- [gradients](https://docs.kit.eigenorbit.com/api/photonics/gradients/index.md)
- [ir](https://docs.kit.eigenorbit.com/api/photonics/ir/index.md)
- [reservoir](https://docs.kit.eigenorbit.com/api/photonics/reservoir/index.md)
- [torch](https://docs.kit.eigenorbit.com/api/photonics/torch/index.md)
- [perceval_backend](https://docs.kit.eigenorbit.com/api/photonics/backends/perceval_backend/index.md)
- [perceval_remote](https://docs.kit.eigenorbit.com/api/photonics/backends/perceval_remote/index.md)
- [qrc](https://docs.kit.eigenorbit.com/api/qml/qrc/index.md)
- [qsvc](https://docs.kit.eigenorbit.com/api/qml/qsvc/index.md)
- [qsvr](https://docs.kit.eigenorbit.com/api/qml/qsvr/index.md)
- [driver](https://docs.kit.eigenorbit.com/api/reservoir/driver/index.md)
- [features](https://docs.kit.eigenorbit.com/api/reservoir/features/index.md)
- [policies](https://docs.kit.eigenorbit.com/api/reservoir/policies/index.md)
- [readout](https://docs.kit.eigenorbit.com/api/reservoir/readout/index.md)
- [circuit](https://docs.kit.eigenorbit.com/api/torch/circuit/index.md)
- [estimators](https://docs.kit.eigenorbit.com/api/torch/estimators/index.md)
- [interface](https://docs.kit.eigenorbit.com/api/torch/interface/index.md)
- [layers](https://docs.kit.eigenorbit.com/api/torch/layers/index.md)
- [custom](https://docs.kit.eigenorbit.com/api/torch/estimators/custom/index.md)
- [generic](https://docs.kit.eigenorbit.com/api/torch/estimators/generic/index.md)
- [hqnc](https://docs.kit.eigenorbit.com/api/torch/estimators/hqnc/index.md)
- [hqnr](https://docs.kit.eigenorbit.com/api/torch/estimators/hqnr/index.md)
- [recurrent_hqnc](https://docs.kit.eigenorbit.com/api/torch/estimators/recurrent_hqnc/index.md)
- [recurrent_hqnr](https://docs.kit.eigenorbit.com/api/torch/estimators/recurrent_hqnr/index.md)
- [timeseries](https://docs.kit.eigenorbit.com/api/torch/estimators/timeseries/index.md)
- [basic](https://docs.kit.eigenorbit.com/api/torch/layers/basic/index.md)
- [ensemble](https://docs.kit.eigenorbit.com/api/torch/layers/ensemble/index.md)
- [minmax](https://docs.kit.eigenorbit.com/api/torch/layers/minmax/index.md)
- [reupload](https://docs.kit.eigenorbit.com/api/torch/layers/reupload/index.md)