Skip to content
This repository has been archived by the owner on Oct 7, 2023. It is now read-only.
/ fold-models Public archive

⚙️ Speedy implementations of TS Models, built specifically for Fold (https://github.com/dream-faster/fold)

License

Notifications You must be signed in to change notification settings

dream-faster/fold-models

Repository files navigation

Baselines Tests Discord Community Calendly Booking


Logo

FOLD-MODELS

Extremely Fast Time Series Models.
To be used with Fold.


Explore the docs »


Available models

Name Usage
Naive from fold_models import Naive
NaiveSeasonal from fold_models import NaiveSeasonal
MovingAverage from fold_models import MovingAverage
AR from fold_models import AR
ARIMA from fold_models import ARIMA

Installation

  • Prerequisites: python >= 3.7 and pip

  • Install from pypi:

    pip install fold-models
    
  • Depending on what model you'd like to wrap, you can either install the library directly or run

    pip install "fold-models[<your_library_name>]"
    

Quickstart

You can quickly train your chosen models and get predictions by running:

  from fold import ExpandingWindowSplitter, train_evaluate
  from fold.utils.dataset import get_preprocessed_dataset
  from fold_models import Naive

  X, y = get_preprocessed_dataset(
      "weather/historical_hourly_la", target_col="temperature", shorten=1000
  )
  model = Naive()
  splitter = ExpandingWindowSplitter(initial_train_window=0.2, step=50)

  scorecard, predictions, trained_pipeline = train_evaluate(model, X, y, splitter)

Our Open-core Time Series Toolkit

Krisi Fold Fold/Models Fold/Wrappers

If you want to try them out, we'd love to hear about your use case and help, please book a free 30-min call with us!

Contribution

Join our Discord for live discussion!

Submit an issue or reach out to us on info at dream-faster.ai for any inquiries.

Licence & Usage

We want to bring much-needed transparency, speed and rigour to the process of creating Time Series ML pipelines, while also building a sustainable business, that can support the ecosystem in the long-term. Fold's licence is inbetween source-available and a traditional commercial software licence. It requires a paid licence for any commercial use, after the initial, 30 day trial period.

We also want to contribute to open research by giving free access to non-commercial, research use of fold.

Read more