Update README.md
Browse files
README.md
CHANGED
@@ -11,7 +11,7 @@ library_name: tirex
|
|
11 |
TiRex is a **time-series foundation model** designed for **time series forecasting**,
|
12 |
with the emphasis to provide state-of-the-art forecasts for both short- and long-term forecasting horizon.
|
13 |
TiRex is **35M parameter** small and is based on the **[xLSTM architecture](https://github.com/NX-AI/xlstm)** allowing fast and performant forecasts.
|
14 |
-
The model is described in the paper [TiRex: Zero-Shot Forecasting across Long and Short Horizons with Enhanced In-Context Learning]()
|
15 |
|
16 |
### Key Facts:
|
17 |
|
@@ -34,7 +34,7 @@ The inference code is available on [GitHub](https://github.com/NX-AI/tirex).
|
|
34 |
TiRex is currently only tested on *Linux systems* and Nvidia GPUs with compute capability >= 8.0.
|
35 |
If you want to use different systems, please check the [FAQ](#faq--troubleshooting).
|
36 |
It's best to install TiRex in the specified conda environment.
|
37 |
-
The respective conda dependency file is [requirements_py26.yaml](
|
38 |
|
39 |
```sh
|
40 |
# 1) Setup and activate conda env from ./requirements_py26.yaml
|
@@ -68,7 +68,7 @@ data = torch.rand((5, 128)) # Sample Data (5 time series with length 128)
|
|
68 |
forecast = model.forecast(context=data, prediction_length=64)
|
69 |
```
|
70 |
|
71 |
-
We provide an extended quick start example in the [GitHub repository](https://github.com/NX-AI/tirex/examples/quick_start_tirex.ipynb).
|
72 |
|
73 |
### Troubleshooting / FAQ
|
74 |
|
@@ -87,7 +87,13 @@ and feel free to create a GitHub issue or start a discussion.
|
|
87 |
If you use TiRex in your research, please cite our work:
|
88 |
|
89 |
```bibtex
|
90 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
91 |
```
|
92 |
|
93 |
## License
|
|
|
11 |
TiRex is a **time-series foundation model** designed for **time series forecasting**,
|
12 |
with the emphasis to provide state-of-the-art forecasts for both short- and long-term forecasting horizon.
|
13 |
TiRex is **35M parameter** small and is based on the **[xLSTM architecture](https://github.com/NX-AI/xlstm)** allowing fast and performant forecasts.
|
14 |
+
The model is described in the paper [TiRex: Zero-Shot Forecasting across Long and Short Horizons with Enhanced In-Context Learning](https://arxiv.org/abs/2505.23719).
|
15 |
|
16 |
### Key Facts:
|
17 |
|
|
|
34 |
TiRex is currently only tested on *Linux systems* and Nvidia GPUs with compute capability >= 8.0.
|
35 |
If you want to use different systems, please check the [FAQ](#faq--troubleshooting).
|
36 |
It's best to install TiRex in the specified conda environment.
|
37 |
+
The respective conda dependency file is [requirements_py26.yaml](https://github.com/NX-AI/tirex/blob/main/requirements_py26.yaml).
|
38 |
|
39 |
```sh
|
40 |
# 1) Setup and activate conda env from ./requirements_py26.yaml
|
|
|
68 |
forecast = model.forecast(context=data, prediction_length=64)
|
69 |
```
|
70 |
|
71 |
+
We provide an extended quick start example in the [GitHub repository](https://github.com/NX-AI/tirex/blob/main/examples/quick_start_tirex.ipynb).
|
72 |
|
73 |
### Troubleshooting / FAQ
|
74 |
|
|
|
87 |
If you use TiRex in your research, please cite our work:
|
88 |
|
89 |
```bibtex
|
90 |
+
@article{auerTiRexZeroShotForecasting2025,
|
91 |
+
title = {{{TiRex}}: {{Zero-Shot Forecasting Across Long}} and {{Short Horizons}} with {{Enhanced In-Context Learning}}},
|
92 |
+
author = {Auer, Andreas and Podest, Patrick and Klotz, Daniel and B{\"o}ck, Sebastian and Klambauer, G{\"u}nter and Hochreiter, Sepp},
|
93 |
+
journal = {ArXiv},
|
94 |
+
volume = {2505.23719},
|
95 |
+
year = {2025}
|
96 |
+
}
|
97 |
```
|
98 |
|
99 |
## License
|