Skip to content

Commit b3c3e20

Browse files
authored
Add tutorials for using custom datasets and models (#1)
1 parent 46d3f20 commit b3c3e20

7 files changed

+3255
-1609
lines changed

Diff for: README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,11 @@ fev.leaderboard(summaries)
9595
# | seasonal_naive | 1 | 3.333 | 0.004 | ... |
9696
```
9797

98-
## Tutorials
99-
- Quick start tutorial: [docs/tutorials/quickstart.ipynb](./docs/tutorials/quickstart.ipynb).
100-
- An in-depth walkthrough of the library: [docs/tutorials/in-depth.ipynb](./docs/tutorials/in-depth.ipynb).
98+
## Documentation
99+
- Quickstart: Define a task and evaluate a model ([docs/01-quickstart.ipynb](./docs/01-quickstart.ipynb)).
100+
- Datasets: Use `fev` with your own datasets ([docs/02-dataset-format.ipynb](./docs/02-dataset-format.ipynb)).
101+
- Tasks & benchmarks: Advanced features for defining tasks and benchmarks ([docs/03-tasks-and-benchmarks.ipynb](./docs/03-tasks-and-benchmarks.ipynb)).
102+
- Models: Evaluate your models and submit results to the leaderboard ([docs/04-models.ipynb](./docs/04-models.ipynb)).
101103

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

0 commit comments

Comments
 (0)