Metadata-Version: 2.5
Name: timecopilot-gift-eval
Version: 0.3.0
Summary: GIFT-Eval benchmark integration for time series forecasters
Author-email: Azul Garza <azul.garza.r@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Requires-Dist: datasets>=4.0
Requires-Dist: gluonts[torch]
Requires-Dist: huggingface-hub<2.0,>=0.36.2
Requires-Dist: pandas>=2.2.0; python_full_version >= '3.13'
Requires-Dist: python-dotenv>=1.0
Requires-Dist: requests>=2.31
Requires-Dist: toolz>=0.12
Requires-Dist: tqdm>=4.66
Requires-Dist: utilsforecast>=0.2.15
Description-Content-Type: text/markdown

# timecopilot-gift-eval

Standalone [GIFT-Eval](https://huggingface.co/spaces/Salesforce/GIFT-Eval) integration for time series forecasters.

Install:

```bash
pip install timecopilot-gift-eval
```

Use with any forecaster that implements the `ForecasterProtocol` interface:

```python
from timecopilot_gift_eval import GIFTEval, GluonTSPredictor

storage_path = "./gift_eval_data"
GIFTEval.download_data(storage_path)

predictor = GluonTSPredictor(forecaster=my_forecaster, batch_size=512)
gift_eval = GIFTEval(
    dataset_name="m4_weekly",
    term="short",
    output_path="./results",
    storage_path=storage_path,
)
gift_eval.evaluate_predictor(predictor)
```

TimeCopilot users can install via the optional extra:

```bash
pip install "timecopilot[gift-eval]"
```

Replication tests against the official GIFT-Eval Seasonal Naive baseline run in this package via `GluonTSPredictor` and a minimal test forecaster. TimeCopilot's integration tests live in [its test suite](https://github.com/TimeCopilot/timecopilot/blob/main/tests/gift_eval/).
