Skip to main content

A fractal econometrics package for python, built with JAX.

Project description

fractrics

PyPI - Version PyPI - Python Version


Table of Contents

Installation

pip install fractrics

Quick example

The main tool in fractrics is the MSM class, an implementation of the univariate Markov Switching Multifractal Model. The logaritmic difference between observations is modeled as the noise-adjusted square root of the product of a chosen number of latent volatility components, each following the dynamics of discrete first order markov chains, whose transition depends on geometrically-spaced Poisson arrivals, and an unconditional term, effectively being the unconditional volatility.

Such structure effectively captures the behaviour of time series with fat tails, hyperbolic correlation decay, and multifractal moments, such as the returns of many financial assets.

The implementation is made in JAX, simplifying parallelization of the code. Moreover, following from this paper, the memory complexity of the forward algorithm is reduced, due to the factorization of latent states.

To use the model, start with an example time series. Note that the model is only defined for positive time series (as it was created to model prices of financial assets).

from fractrics.time_series.MSM import MSM
import jax.numpy as jnp
import numpy as np

ts_test = jnp.array(np.random.normal(50, 10, 10))

Then initialize the model. It requires the following hyperparameters:

  • n_latent: how many volatility components, integer.
  • marg_prob_mass: the probability mass of the marginal distribution of the latent states, needs to sum to 1.
model = MSM(ts=ts_test, n_latent=3)

To fit the model to the data, start with an initial guess. The MSM.fit() method then optimizes the parameters using jaxopt's Broyden–Fletcher–Goldfarb–Shanno algorithm.

By assumption, all the parameters need to be positive, and have further individual constrains:

  • marg_support: the support of the marginal probability mass defined in the parameters. It needs to have unity expectation. In the symmetric binomial case, this can be enforced by specifying one value $m_0$, and having the second value be $2 - m_0$.

  • unconditional_term: the unconditional distribution of the model, a positive double.

  • arrival_gdistance: the geometric distance between the Poisson arrivals of each latent volatility component, a positive double.

  • hf_arrival: the highest poisson arrival probability (i.e. the proability of state switch of the highest frequency component).

Note: to maintain the constrains during optimization, the parameters are transformed using mappings.

initial_params = jnp.array([
    2,    #unconditional term
    3.0,    #arrival_gdistance
    0.98,   #hf_arrival

    #support
    1.5,    
    0.5
])

msm_result = model.fit(initial_parameters=initial_params, maxiter=1000)

msm_result is a custom dataclass (msm_metadata) that contains relevant information about the model. This construct reduces the verbosity of the API, as it can be passed as the only input required to operate with the following methods.

It contains:

  • filtered: a dictionary containing the current distribution of the latent components, the list of distribution list at each time step, inferred using the forward algorithm, the transition tensor of the model (in factor form), and the vector of latent states
  • parameters: a dictionary containing the model parameters
  • hyperparameters: a dictionary containing the hyperparameters of the model (the number of volatility components and the marginal probability mass)
  • optimization_info: information about the optimization process
  • name: the internal name of the model (defaults to "MSM")
  • data: the input data
  • data_log_change: the logarithmic change between each data point and its next observation (e.g. the log. return if the original data is a series of financial prices).
print(msm_result.parameters)
{'unconditional_term': Array(0.27496925, dtype=float32), 'arrival_gdistance': Array(3.3334007, dtype=float32), 'hf_arrival': Array(0.265644, dtype=float32), 'marginal_support': Array([1.0000088 , 0.99999124], dtype=float32)}

It is also possible to make simulations with the MSM. The MSM.simulation method takes a msm_metadata object as input to choose the parameters, as it is intended to be used to simulate data from a fitted model, as above. If the user wants to simulate from chosen parameters, a msm_metadata object needs to be initialized with them.

Follows an example with the parameters of the fitted model above. It returns a tuple containing the simulated logarithmic change (e.g. 1 step return) and corresponding implied volatility.

ret, vol = model.simulation(n_simulations = 1000, model_info = msm_result)

Finally a 7 period forecast. The method returns the predictive distribution at each forecast horizon, so that it may be used for both point-expectation and uncertainty intervals.

forecast = model.forecast(horizon=7, model_info=msm_result)

Project Structure

.
├── notebooks                     # [example jupyter notebooks]
└── src/fractrics                 # [main code repository]
    ├── _pending_refactor         # legacy code that needs to be restructured
    ├── _ts_components            # abstract classes and methods for time series
    ├── time_series               # concretization classes for time series models
    └── diagnostics.py            # Statistics to test performances of models

Planned updates

  • _ts_components/_HMM/base.py:
    • implementing viterbi and backwards algorithms
    • generalize components of the forward algorithms that apply to other hidden markov models
  • MSM:
    • implement standard errors and robust standard erros of the parameters (pseudo-code commented in already)
    • implement model selection metrics
    • model implied moments, value at risk.
    • Allow for creating simulations without initializing the model with a time series.
  • diagnostics.py: adding other common metrics.
  • refactoring the functions in _pending_refactor.

References

  • Calvet, L.E. and Fisher, A.J. (2004). How to Forecast Long-Run Volatility: Regime Switching and the Estimation of Multifractal Processes. Journal of Financial Econometrics, 2(1).

  • Calvet, L.E. and Fisher, A.J. (2008). Multifractal Volatility. Theory, Forecasting, and Pricing. Academic Press.

  • Calvet, L.E., Fisher, A.J. and Thompson, S.B. (2004). Volatility Comovement: A Multifrequency Approach. SSRN Electronic Journal. doi:https://doi.org/10.2139/ssrn.582541.

  • Ghahramani, Z. and Jordan, M.I. (1997). Factorial Hidden Markov Models. Machine Learning, 29(2/3), pp.245–273. doi:https://doi.org/10.1023/a:1007425814087.

  • Lux, T. (2008). The Markov-Switching Multifractal Model of Asset Returns. Journal of Business & Economic Statistics, 26(2), pp.194–210. doi:https://doi.org/10.1198/073500107000000403.

  • Lux, T. (2020). Inference for Nonlinear State Space Models: A Comparison of Different Methods applied to Markov-Switching Multifractal Models. Econometrics and Statistics. doi:https://doi.org/10.1016/j.ecosta.2020.03.001.

  • Lux, T., Morales-Arias, L. and Sattarhoff, C. (2011). A Markov-switching multifractal approach to forecasting realized volatility. [online] Kiel Working Papers. Available at: https://ideas.repec.org/p/zbw/ifwkwp/1737.html [Accessed 30 May 2025].

  • Murphy, K.P. (2012). Machine learning : a probabilistic perspective. Cambridge (Ma): Mit Press.

  • Rypdal, M. and Løvsletten, O. (2011). Multifractal modeling of short-term interest rates. arXiv (Cornell University).

License

fractrics is distributed under the terms of the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fractrics-0.2.0.tar.gz (30.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fractrics-0.2.0-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

Details for the file fractrics-0.2.0.tar.gz.

File metadata

  • Download URL: fractrics-0.2.0.tar.gz
  • Upload date:
  • Size: 30.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for fractrics-0.2.0.tar.gz
Algorithm Hash digest
SHA256 c7a0ced059114471c6dd36be7874065ae0a2519fd86e1faaef52da1724d538ef
MD5 ccd292aeca322e05c9783eae7ae40685
BLAKE2b-256 a64d79138ebefe7b680470f9b369fd06c547af23e54c9e6b1e5b7adbf708e089

See more details on using hashes here.

File details

Details for the file fractrics-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: fractrics-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 30.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for fractrics-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5891b0214239cd5a40f732b41f195b8c807b6db315842ad55677876d3240ee61
MD5 b90514aaff3815b4c3a19df043ef2803
BLAKE2b-256 b6de31fef43e60c8c60116e3e7f0a062f02d792473770264ec318f9c256496fb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page