Skip to main content

GradientDrift

PyPI Version Python Versions Tests License

GradientDrift is a Python library for high-performance econometric time series analysis, specifically designed for datasets that are too large to fit into memory. It leverages the power of JAX for hardware acceleration (CPU/GPU/TPU) and just-in-time (JIT) compilation of models.

⚠️ Under Active Development

This project is currently in a pre-release (beta) stage. The API may change in future versions, and while thoroughly tested, some model implementations should be considered experimental. We welcome feedback and contributions to stabilize and improve the library!


Key Features

  • Memory Efficient: Processes data in batches, allowing you to train models on datasets of any size.
  • High-Performance: Uses JAX to JIT-compile and accelerate model fitting, making it significantly faster than traditional libraries for many workloads.
  • Classic Models, Modern Backend: Implements standard econometric models like VAR (Vector Autoregression) and GARCH with a modern, functional, and hardware-agnostic backend.
  • Clean API: A simple, intuitive interface for defining, fitting, and predicting with your models.

Installation

You can install GradientDrift directly from PyPI:

pip install gradientdrift

Quickstart

Here is a simple example of how to use GradientDrift to fit a VAR model on a sample dataset.

import jax
import pandas as pd
import gradientdrift as gd 

numberOfLags = 1
numberOfVariables = 2

# The dataset object also accepts numpy arrays
data = gd.data.Dataset(pd.read_csv("test_data.csv"))

# Use any of the models, the fit and summary syntax bellow will be equivalent
model = gd.models.VAR(numberOfLags = numberOfLags, numberOfVariables = numberOfVariables)

# Fit the model (default uses ADAM optimizer)
model.fit(data, batchSize = 100)

# Optionally, provide the data to the summary function, this will calculate the confidence interval (but can be expensive)
model.summary(data)

# Alternative optimizers:
model.fit(data, optimizer="lbfgs")
model.fit(data, optimizer="ClosedForm")

A GARCH example where we first simulate data using a model specification:

# Define the true parameters of a model
trueParams = {
    'mu': 0.05,
    'logOmega': jax.numpy.log(0.1),
    'logAlpha': jax.numpy.log(0.1),
    'logBeta': jax.numpy.log(0.85)
}

# Define a model
generatorModel = gd.models.GARCH(p=1, q=1)
generatorModel.setParameters(trueParams)
initialValues = generatorModel.getInitialValues()

# Simulate data
simulatedData = generatorModel.simulate(initialValues, steps=1000000)

# Put in a dataset container for batching
data = gd.data.Dataset(simulatedData)

# Fit the model
model = gd.models.GARCH(p = 1, q = 1)
model.fit(data)
model.summary(data, trueParams = trueParams) # Provide true params to show in the coefficient table

Contributing

Contributions are welcome! Whether it's bug reports, feature requests, or new model implementations, your help is appreciated.

Please feel free to open an issue on the GitHub Issue Tracker to start a discussion. If you plan to contribute code, please see the (forthcoming) CONTRIBUTING.md file for guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Metadata

Release files for gradientdrift 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gradientdrift 0.2.0
File Size Uploaded Provenance Actions
gradientdrift-0.2.0.tar.gz 13.9 kB Without provenance Details for gradientdrift-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for gradientdrift 0.2.0
File Interpreter ABI Platform Actions
gradientdrift-0.2.0-py3-none-any.whl Python 3 none any Details for gradientdrift-0.2.0-py3-none-any.whl

Total release size: 27.9 kB

Release files / gradientdrift-0.2.0.tar.gz

Download URL gradientdrift-0.2.0.tar.gz
Size 13.9 kB
Tags Source
SHA-256 checksum
How to use checksums
522b25981bcc2f8cdf691bc13b88dc133d39dc945ca4abd49747ec64e9d6b5f8
BLAKE2b-256 checksum
How to use checksums
60e70669ebf08346bc328070ab74f559a01f541e0da0127099909e7b4fca3e45
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release files / gradientdrift-0.2.0-py3-none-any.whl

Download URL gradientdrift-0.2.0-py3-none-any.whl
Size 13.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
811ef0fdd84bbc07d3e7ce8e56c3611c35d41e7b6ad7a5579d5263c8fb1036f6
BLAKE2b-256 checksum
How to use checksums
ff3fd4902e448678fc184c0c8b4bac514bc2e1a5f4b9ca9f9e3198ab6166507c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Security for gradientdrift 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page