qiskit-documentation/docs/api/qiskit/0.25/qiskit_finance.mdx

35 lines
2.5 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: finance
description: API reference for qiskit.finance
in_page_toc_min_heading_level: 2
python_api_type: module
python_api_name: qiskit.finance
---
<span id="module-qiskit.finance" />
<span id="qiskit-finance" />
# Qiskits finance module
<span id="module-qiskit.finance" />
`qiskit.finance`
This is the Qiskit\`s finance module. There is an initial set of function here that will be built out over time. At present it has applications in the form of Ising Hamiltonians. Some financial uncertainty problem components and data providers which supply a source of financial data.
| | |
| --------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| [`QiskitFinanceError`](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") | Class for errors returned by Qiskits finance module. |
In addition to standard Python errors Qiskits finance module will raise this error if circumstances are that it cannot proceed to completion.
## Submodules
| | |
| ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [`applications`](qiskit.finance.applications#module-qiskit.finance.applications "qiskit.finance.applications") | Finance applications ([`qiskit.finance.applications`](qiskit.finance.applications#module-qiskit.finance.applications "qiskit.finance.applications")) |
| [`components`](qiskit.finance.components#module-qiskit.finance.components "qiskit.finance.components") | Finance Components ([`qiskit.finance.components`](qiskit.finance.components#module-qiskit.finance.components "qiskit.finance.components")) |
| [`data_providers`](qiskit.finance.data_providers#module-qiskit.finance.data_providers "qiskit.finance.data_providers") | Data Providers ([`qiskit.finance.data_providers`](qiskit.finance.data_providers#module-qiskit.finance.data_providers "qiskit.finance.data_providers")) |