Instructions to use NX-AI/TiRex-2 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- TiRex-2
How to use NX-AI/TiRex-2 with TiRex-2:
# No code snippets available yet for this library. # To use this model, check the repository files and the library's documentation. # Want to help? PRs adding snippets are welcome at: # https://github.com/huggingface/huggingface.js
- Notebooks
- Google Colab
- Kaggle
Update README.md
Browse filesAligned with GitHub README
README.md
CHANGED
|
@@ -21,6 +21,9 @@ covariates. A single checkpoint serves both univariate and multivariate forecast
|
|
| 21 |
operates in a streaming fashion as new observations arrive — all zero-shot, with no
|
| 22 |
task-specific training or fine-tuning.
|
| 23 |
|
|
|
|
|
|
|
|
|
|
| 24 |
## Key facts
|
| 25 |
|
| 26 |
- **Zero-shot multivariate forecasting**:
|
|
@@ -34,11 +37,26 @@ task-specific training or fine-tuning.
|
|
| 34 |
TiRex-2 activates 38.4M parameters in univariate mode and an additional 44.1M parameters
|
| 35 |
for multivariate forecasting.
|
| 36 |
|
| 37 |
-
# Getting started
|
| 38 |
|
| 39 |
> 📖 For a detailed guide — including pip installation, a Google Colab demo, covariate
|
| 40 |
> examples, and benchmark reproduction — see our [GitHub repository](https://github.com/NX-AI/tirex-2).
|
| 41 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 42 |
|
| 43 |
The environment is managed by [Pixi](https://pixi.prefix.dev/latest/). Run the following to install it on your machine
|
| 44 |
|
|
@@ -66,6 +84,17 @@ We provide predefined Pixi tasks showcasing examplary forecasts. These run in th
|
|
| 66 |
|
| 67 |
For a more **interactive demo of TiRex-2**, we also provide a [quick-start](https://github.com/NX-AI/tirex-2/blob/main/examples/getting_started.ipynb) notebook.
|
| 68 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 69 |
## Cite
|
| 70 |
If you use TiRex-2 in your research, please cite our work:
|
| 71 |
```bibtex
|
|
|
|
| 21 |
operates in a streaming fashion as new observations arrive — all zero-shot, with no
|
| 22 |
task-specific training or fine-tuning.
|
| 23 |
|
| 24 |
+
TiRex-2 generalizes our original univariate model, [TiRex](https://huggingface.co/NX-AI/TiRex), to
|
| 25 |
+
multivariate forecasting with past and future covariates.
|
| 26 |
+
|
| 27 |
## Key facts
|
| 28 |
|
| 29 |
- **Zero-shot multivariate forecasting**:
|
|
|
|
| 37 |
TiRex-2 activates 38.4M parameters in univariate mode and an additional 44.1M parameters
|
| 38 |
for multivariate forecasting.
|
| 39 |
|
| 40 |
+
## Getting started
|
| 41 |
|
| 42 |
> 📖 For a detailed guide — including pip installation, a Google Colab demo, covariate
|
| 43 |
> examples, and benchmark reproduction — see our [GitHub repository](https://github.com/NX-AI/tirex-2).
|
| 44 |
|
| 45 |
+
### Access to Model Weights
|
| 46 |
+
|
| 47 |
+
TiRex-2's model weights are gated on Hugging Face. To be able to access them, either log in via the Hugging Face CLI, or [generate yourself a Hugging Face access token](https://huggingface.co/settings/tokens/new?canReadGatedRepos=true&tokenType=fineGrained) (make sure to enable Read access to contents of all public gated repos you can access) and set it before loading the model:
|
| 48 |
+
|
| 49 |
+
CLI:
|
| 50 |
+
```bash
|
| 51 |
+
huggingface-cli login
|
| 52 |
+
```
|
| 53 |
+
|
| 54 |
+
Access Token:
|
| 55 |
+
|
| 56 |
+
```bash
|
| 57 |
+
import os
|
| 58 |
+
os.environ["HF_TOKEN"] = "<insert-hf-token>"
|
| 59 |
+
```
|
| 60 |
|
| 61 |
The environment is managed by [Pixi](https://pixi.prefix.dev/latest/). Run the following to install it on your machine
|
| 62 |
|
|
|
|
| 84 |
|
| 85 |
For a more **interactive demo of TiRex-2**, we also provide a [quick-start](https://github.com/NX-AI/tirex-2/blob/main/examples/getting_started.ipynb) notebook.
|
| 86 |
|
| 87 |
+
## TiRex-2 Pro
|
| 88 |
+
TiRex-2 already provides state-of-the-art performance for zero-shot prediction, so you can use this open-source release without training on your own data.
|
| 89 |
+
|
| 90 |
+
Our pro version extends TiRex-2 with additional capabilities, including:
|
| 91 |
+
|
| 92 |
+
Streaming: incremental forecast updates as new observations arrive, without recomputing over the full history.
|
| 93 |
+
Speed: performance-optimized inference, including optimization for dedicated hardware such as edge, embedded, and industrial PC deployments.
|
| 94 |
+
Finetuning: models fine-tuned on your data or with different pretraining.
|
| 95 |
+
Classification & Regression: TiRex-2 adapted for classification and regression tasks.
|
| 96 |
+
If you are interested in any of these, please contact us at contact@nx-ai.com.
|
| 97 |
+
|
| 98 |
## Cite
|
| 99 |
If you use TiRex-2 in your research, please cite our work:
|
| 100 |
```bibtex
|