Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
microprediction authored Oct 21, 2024
1 parent c354834 commit 5f00a76
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
# timemachines ([docs](https://microprediction.github.io/timemachines/)) ![simple](https://github.com/microprediction/timemachines/workflows/tests/badge.svg) ![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)


Univariate prediction functions from diverse packages supported in a simple stateless pure function syntax. Here `yt` is a vector or scalar, and we want to predict `yt` (or its first coordinate if `yt` is a vector) three steps in advance.
Univariate prediction functions from diverse packages supported in a simple stateless pure function syntax, mosty for benchmarking and selection purposes. Here `yt` is a vector or scalar, and we want to predict `yt` (or its first coordinate if `yt` is a vector) three steps in advance.

from timemachines.skaters.somepackage.somevariety import something as f
for yt in y:
xt, xt_std, s = f(y=yt, s=s, k=3)
This emits a k-vector xt of forecasts, and corresponding k-vector xt_std of estimated standard errors. See [skaters](https://microprediction.github.io/timemachines/skaters) for choices of somepackage, somevariety and something. You can also ensemble, compose, bootstrap and do other things with one line of code.


These are ([documented](https://microprediction.github.io/timemachines/) and [assessed](https://microprediction.github.io/timeseries-elo-ratings/html_leaderboards/overall.html)).
This emits a k-vector xt of forecasts, and corresponding k-vector xt_std of estimated standard errors. See [skaters](https://microprediction.github.io/timemachines/skaters) for choices of `somepackage`, `somevariety` and `something`. You can also ensemble, compose, bootstrap and do other things with one line of code. The `f` is called a `skater`. These are ([documented](https://microprediction.github.io/timemachines/) and [assessed](https://microprediction.github.io/timeseries-elo-ratings/html_leaderboards/overall.html)).

The following packages probably work well in this context.
- ![tsa](https://github.com/microprediction/timemachines/workflows/test-tsa/badge.svg)
- ![darts](https://github.com/microprediction/timemachines/workflows/test-darts/badge.svg)
- ![greykite](https://github.com/microprediction/timemachines/workflows/test-greykite/badge.svg)
Test for the following packages are expected to be working.
- ![tsa](https://github.com/microprediction/timemachines/workflows/test-tsa/badge.svg) Statsmodels
- ![darts](https://github.com/microprediction/timemachines/workflows/test-darts/badge.svg)
- ![greykite](https://github.com/microprediction/timemachines/workflows/test-greykite/badge.svg)
- ![sktime](https://github.com/microprediction/timemachines/workflows/test-sktime/badge.svg)
- ![tbats](https://github.com/microprediction/timemachines/workflows/test-tbats/badge.svg)
- ![simdkalman](https://github.com/microprediction/timemachines/workflows/test-simdkalman/badge.svg)
Expand Down

0 comments on commit 5f00a76

Please sign in to comment.