Skip to main content
IBM Quantum Platform
This page is from an old version of Qiskit SDK and does not exist in the latest version. We recommend you migrate to the latest version. See the release notes for more information.

BaseDataProvider

class BaseDataProvider

GitHub

Bases: abc.ABC

The abstract base class for data_provider modules within Qiskit’s finance module.

To create add-on data_provider module subclass the BaseDataProvider class in this module. Doing so requires that the required driver interface is implemented.

To use the subclasses, please see https://github.com/Qiskit/qiskit-tutorials/blob/stable/0.25.x/tutorials/finance/11_time_series.ipynb


Methods

get_coordinates

BaseDataProvider.get_coordinates()

Returns random coordinates for visualisation purposes.

Return type

Tuple[ndarray, ndarray]

get_covariance_matrix

BaseDataProvider.get_covariance_matrix()

Returns the covariance matrix.

Return type

ndarray

Returns

an asset-to-asset covariance matrix.

Raises

QiskitFinanceError – no data loaded

get_mean_vector

BaseDataProvider.get_mean_vector()

Returns a vector containing the mean value of each asset.

Return type

ndarray

Returns

a per-asset mean vector.

Raises

QiskitFinanceError – no data loaded

get_period_return_covariance_matrix

BaseDataProvider.get_period_return_covariance_matrix()

Returns a vector containing the mean value of each asset.

Return type

ndarray

Returns

a per-asset mean vector.

Raises

QiskitFinanceError – no data loaded

get_period_return_mean_vector

BaseDataProvider.get_period_return_mean_vector()

Returns a vector containing the mean value of each asset.

Return type

ndarray

Returns

a per-asset mean vector.

Raises

QiskitFinanceError – no data loaded

get_similarity_matrix

BaseDataProvider.get_similarity_matrix()

Returns time-series similarity matrix computed using dynamic time warping.

Return type

ndarray

Returns

an asset-to-asset similarity matrix.

Raises

QiskitFinanceError – no data loaded

run

abstract BaseDataProvider.run()

Loads data.

Return type

None

Was this page helpful?
Report a bug or request content on GitHub.