QFinance
Copyright (c) 2023 Institute for Quantum Computing, Baidu Inc. All Rights Reserved.
About QFinance
QFinance is a Quantum Finance library based on the QCompute SDK. It provides a set of tools for building quantum algorithms for finance. Currently, it supports the following features:
- Pricing European options using Quantum Monte Carlo method
- Pricing European options using classical methods, including
- Black-Scholes-Merton method
- Classical Monte Carlo method
The following quantum algorithms are implemented in QFinance:
- Quantum Monte Carlo algorithm for simple piecewise linear payoff function
- Arbitrary quantum state preparation
- Quantum Fourier transform
- Quantum phase estimation
- Quantum amplitude estimation algorithms:
- Canonical Quantum Amplitude Estimation [Brassard 2002]
- Maximum Likelihood Amplitude Estimation [Suzuki 2019]
- Iterative Quantum Amplitude Estimation [Grinko 2019]
Installation
QFinance is available on PyPI. To install the latest release, run:
pip install qfinance
pip will handle all dependencies automatically.
Examples
Option Pricing
import QCompute
QCompute.Define.Settings.outputInfo = False
from QFinance.pricing import EuropeanOptionPricingClassical, EuropeanCallQMC
# set parameters
# s0 is the current price of the underlying asset
# k is the strike price
# t is the time to maturity (in years)
# r is the risk-free interest rate
# sigma is the volatility of the underlying asset
s0 = 100
k = 90
t = 1
r = 0.05
sigma = 0.1
########################################################################################
option_classical = EuropeanOptionPricingClassical(s0, k, t, r, sigma, "call", "long")
# option price calculated by Black-Scholes-Merton model
bsm_price = option_classical.bsm_price()
option_classical.set_CMC_sample_size(1000000)
# option price calculated by Classical Monte Carlo method
cmc_price = option_classical.cmc_price()
option_classical.show_info()
########################################################################################
option = EuropeanCallQMC(s0, k, t, r, sigma)
option.set_num_qubits(3)
option.set_scaling(0.04)
# set MLAE configuration
option.method = "MLAE"
Q_powers = [2, 3, 5, 10]
shots = [100000] * len(Q_powers)
price_qmc = option.get_price_mlae(Q_powers, shots)
print(f"BSM price: \t{bsm_price:.5f}")
print(f"CMC price: \t{cmc_price:.5f}")
print(f"QMC price: \t{price_qmc:.5f}")
The typical output is as follows:
European option pricing with the following parameters:
option type: call, long
current stock price: s0 = 100
strike price: k = 90
time to maturity (in years): t = 1
risk-free interest rate: r = 0.05
volatility: sigma = 0.1
=================== Running MLAE algorithm ======================
powers of Q are: [2, 3, 5, 10]
number of shots are: [100000, 100000, 100000, 100000]
Applying Q^2 to the state A|0>^8...
Time elapsed: 0.2348 seconds.
Applying Q^3 to the state A|0>^8...
Time elapsed: 0.3460 seconds.
Applying Q^5 to the state A|0>^8...
Time elapsed: 0.5540 seconds.
Applying Q^10 to the state A|0>^8...
Time elapsed: 1.0420 seconds.
===================== MLAE algorithm finished. ====================
BSM price: 14.62884
CMC price: 14.62937
QMC price: 14.62056
License
QFinance uses the Apache License 2.0.
Metadata
Release files for qfinance 1.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| qfinance-1.0.3.tar.gz | 35.5 kB | Without provenance | Details for qfinance-1.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| qfinance-1.0.3-py3-none-any.whl | Python 3 | none | any | Details for qfinance-1.0.3-py3-none-any.whl |
Total release size: 90.2 kB
Release files / qfinance-1.0.3.tar.gz
| Download URL | qfinance-1.0.3.tar.gz |
|---|---|
| Size | 35.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d8bcd338e70798e1aecfb70e7539a9a56de362e650d4bf6c7b543a324ed6b2cf
|
|
BLAKE2b-256 checksum How to use checksums |
ca44a9ee18b107198a12637289250995c578980a10240efed9ec92df777928d0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.9
|
Release files / qfinance-1.0.3-py3-none-any.whl
| Download URL | qfinance-1.0.3-py3-none-any.whl |
|---|---|
| Size | 54.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f52273b9596294c774fdf4b57d87ed1dde7706e3380caeeb80362a946764f56c
|
|
BLAKE2b-256 checksum How to use checksums |
a8e5b7d415af66ee400ec77f591cfbb13944a283a2c7f33ae333687e4296fc34
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.9
|
Security for qfinance 1.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.