Skip to content

synthetic module

Module with SyntheticData.

SyntheticData class

SyntheticData(
    wrapper,
    data,
    single_key=True,
    classes=None,
    level_name=None,
    fetch_kwargs=None,
    returned_kwargs=None,
    last_index=None,
    delisted=None,
    tz_localize=None,
    tz_convert=None,
    missing_index=None,
    missing_columns=None,
    **kwargs
)

Data class for fetching synthetic data.

Exposes an abstract class method SyntheticData.generate_symbol. Everything else is taken care of.

Superclasses

Inherited members

Subclasses

fetch_feature class method

SyntheticData.fetch_feature(
    feature,
    **kwargs
)

Generate data of a feature.

Uses SyntheticData.fetch_key with key_is_feature=True.

fetch_key class method

SyntheticData.fetch_key(
    key,
    key_is_feature=False,
    start=None,
    end=None,
    periods=None,
    timeframe=None,
    tz=None,
    normalize=None,
    inclusive=None,
    **kwargs
)

Generate data of a feature or symbol.

Generates datetime index using date_range and passes it to SyntheticData.generate_key to fill the Series/DataFrame with generated data.

For defaults, see custom.synthetic in data.

fetch_symbol class method

SyntheticData.fetch_symbol(
    symbol,
    **kwargs
)

Generate data for a symbol.

Uses SyntheticData.fetch_key with key_is_feature=False.

generate_feature class method

SyntheticData.generate_feature(
    feature,
    index,
    **kwargs
)

Abstract method to generate data of a feature.

Uses SyntheticData.generate_key with key_is_feature=True.

generate_key class method

SyntheticData.generate_key(
    key,
    index,
    key_is_feature=False,
    **kwargs
)

Abstract method to generate data of a feature or symbol.

generate_symbol class method

SyntheticData.generate_symbol(
    symbol,
    index,
    **kwargs
)

Abstract method to generate data for a symbol.

Uses SyntheticData.generate_key with key_is_feature=False.

update_feature method

SyntheticData.update_feature(
    feature,
    **kwargs
)

Update data of a feature.

Uses SyntheticData.update_key with key_is_feature=True.

update_key method

SyntheticData.update_key(
    key,
    key_is_feature=False,
    **kwargs
)

Update data of a feature or symbol.

update_symbol method

SyntheticData.update_symbol(
    symbol,
    **kwargs
)

Update data for a symbol.

Uses SyntheticData.update_key with key_is_feature=False.