Skip to content

Commit 30c2742

Browse files
authored
Update readme for v0.6.0 (#45)
1 parent 17f9a3c commit 30c2742

File tree

1 file changed

+21
-16
lines changed

1 file changed

+21
-16
lines changed

README.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,15 @@ Existing forecasting benchmarks usually fall into one of two categories:
1515

1616
`fev` aims for the middle ground - it provides the core benchmarking functionality without introducing unnecessary constraints or bloated dependencies. The library supports point & probabilistic forecasting, different types of covariates, as well as all popular forecasting metrics.
1717

18-
## Installation
18+
## 📝 Updates
19+
- **2025-09-16**: The new version `0.6.0` contains major new functionality, [updated documentation](https://autogluon.github.io/fev/latest/), as well as some breaking changes to the `Task` API. Please check the [release notes](https://github.com/autogluon/fev/releases) for more details.
20+
21+
## ⚙️ Installation
1922
```
2023
pip install fev
2124
```
2225

23-
## Quickstart
26+
## 🚀 Quickstart
2427

2528
Create a task from a dataset stored on Hugging Face Hub
2629
```python
@@ -42,7 +45,7 @@ for window in task.iter_windows():
4245

4346
Make predictions
4447
```python
45-
def naive_forecast(y: list, horizon: int) -> dict[str, list]:
48+
def naive_forecast(y: list, horizon: int) -> dict[str, list[float]]:
4649
# Make predictions for a single time series
4750
return {"predictions": [y[-1] for _ in range(horizon)]}
4851

@@ -92,29 +95,31 @@ Multiple evaluation summaries produced by different models on different tasks ca
9295
# Dataframes, dicts, JSON or CSV files supported
9396
summaries = "https://raw.githubusercontent.com/autogluon/fev/refs/heads/main/benchmarks/example/results/results.csv"
9497
fev.leaderboard(summaries)
95-
# | model_name | gmean_relative_error | avg_rank | avg_inference_time_s | ... |
96-
# |:---------------|-----------------------:|-----------:|-----------------------:|------:|
97-
# | auto_theta | 0.874 | 2 | 5.501 | ... |
98-
# | auto_arima | 0.887 | 2 | 21.799 | ... |
99-
# | auto_ets | 0.951 | 2.667 | 0.737 | ... |
100-
# | seasonal_naive | 1 | 3.333 | 0.004 | ... |
98+
# | model_name | skill_score | win_rate | ... |
99+
# |:---------------|--------------:|-----------:| ... |
100+
# | auto_theta | 0.126 | 0.667 | ... |
101+
# | auto_arima | 0.113 | 0.667 | ... |
102+
# | auto_ets | 0.049 | 0.444 | ... |
103+
# | seasonal_naive | 0 | 0.222 | ... |
101104
```
102105

103-
## Tutorials
104-
- [Quickstart](./docs/01-quickstart.ipynb): Define a task and evaluate a model.
105-
- [Datasets](./docs/02-dataset-format.ipynb): Use `fev` with your own datasets.
106-
- [Tasks & benchmarks](./docs/03-tasks-and-benchmarks.ipynb): Advanced features for defining tasks and benchmarks.
107-
- [Models](./docs/04-models.ipynb): Evaluate your models and submit results to the leaderboard.
106+
## 📚 Documentation
107+
- Tutorials
108+
- [Quickstart](https://autogluon.github.io/fev/latest/tutorials/01-quickstart/): Define a task and evaluate a model.
109+
- [Datasets](https://autogluon.github.io/fev/latest/tutorials/02-dataset-format/): Use `fev` with your own datasets.
110+
- [Tasks & benchmarks](https://autogluon.github.io/fev/latest/tutorials/03-tasks-and-benchmarks/): Advanced features for defining tasks and benchmarks.
111+
- [Models](https://autogluon.github.io/fev/latest/tutorials/04-models/): Evaluate your models and submit results to the leaderboard.
112+
- [API reference](https://autogluon.github.io/fev/latest/api/task/)
108113

109114
Examples of model implementations compatible with `fev` are available in [`examples/`](./examples/).
110115

111116

112-
## Leaderboards
117+
## 🏅 Leaderboards
113118
We host leaderboards obtained using `fev` under https://huggingface.co/spaces/autogluon/fev-leaderboard.
114119

115120
Currently, the leaderboard includes the results from the Benchmark II introduced in [Chronos: Learning the Language of Time Series](https://arxiv.org/abs/2403.07815). We expect to extend this list in the future.
116121

117-
## Datasets
122+
## 📈 Datasets
118123
Repositories with datasets in format compatible with `fev`:
119124
- [`chronos_datasets`](https://huggingface.co/datasets/autogluon/chronos_datasets)
120125
- [`fev_datasets`](https://huggingface.co/datasets/autogluon/fev_datasets)

0 commit comments

Comments
 (0)