bayesline.api.equity.RiskDatasetApi

class bayesline.api.equity.RiskDatasetApi

Bases: ABC

Methods

__init__()
describe()
update([force])	Checks the underlying datasets for updates and updates this dataset to the latest versions.
update_as_task()

Attributes

settings

abstract property settings: RiskDatasetSettings

abstract describe() → RiskDatasetProperties

abstract update(force: bool = False) → RiskDatasetUpdateResult

Checks the underlying datasets for updates and updates this dataset to the latest versions.

Parameters

force: bool

If true, the update will be forced even if the dataset is up to date.

Raises

DatasetError

if an error occurs

Returns

RiskDatasetUpdateResult

The result of the update operation.

abstract update_as_task() → Task[RiskDatasetUpdateResult]