Skip to content

docs: add badges to the READMEs #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nfnt merged 1 commit into from
Oct 22, 2026
Merged

docs: add badges to the READMEs #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# datafusion-forecast

[![CI](https://github.com/nfnt/datafusion-forecast/actions/workflows/check.yml/badge.svg)](https://github.com/nfnt/datafusion-forecast/actions/workflows/check.yml)
[![license](https://img.shields.io/github/license/nfnt/datafusion-forecast.svg)](LICENSE)

Forecasts with Mistral AI's [Timestral](https://github.com/mistralai/timestral) time-series models inside
[Apache DataFusion](https://datafusion.apache.org) SQL. The `forecast` aggregate function treats each group as a series
and returns a median and 21 quantiles for each step ahead. The model runs natively in Rust on
Expand Down
6 changes: 6 additions & 0 deletions crates/candle-timestral/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# candle-timestral

[![crates.io](https://img.shields.io/crates/v/candle-timestral.svg)](https://crates.io/crates/candle-timestral)
[![docs.rs](https://img.shields.io/docsrs/candle-timestral)](https://docs.rs/candle-timestral)
[![CI](https://github.com/nfnt/datafusion-forecast/actions/workflows/check.yml/badge.svg)](https://github.com/nfnt/datafusion-forecast/actions/workflows/check.yml)
[![license](https://img.shields.io/crates/l/candle-timestral.svg)](https://github.com/nfnt/datafusion-forecast/blob/main/LICENSE)
[![MSRV](https://img.shields.io/crates/msrv/candle-timestral.svg)](https://crates.io/crates/candle-timestral)

Inference for Timestral checkpoints (e.g. [`mistralai/Timestral-5M`](https://huggingface.co/mistralai/Timestral-5M))
in Rust with [Candle](https://github.com/huggingface/candle), ported from the reference Python package. It loads the
released `config.json` + `model.safetensors` and reproduces `TimestralForecaster.forecast`: multivariate context,
Expand Down
6 changes: 6 additions & 0 deletions crates/datafusion-forecast/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# datafusion-forecast

[![crates.io](https://img.shields.io/crates/v/datafusion-forecast.svg)](https://crates.io/crates/datafusion-forecast)
[![docs.rs](https://img.shields.io/docsrs/datafusion-forecast)](https://docs.rs/datafusion-forecast)
[![CI](https://github.com/nfnt/datafusion-forecast/actions/workflows/check.yml/badge.svg)](https://github.com/nfnt/datafusion-forecast/actions/workflows/check.yml)
[![license](https://img.shields.io/crates/l/datafusion-forecast.svg)](https://github.com/nfnt/datafusion-forecast/blob/main/LICENSE)
[![MSRV](https://img.shields.io/crates/msrv/datafusion-forecast.svg)](https://crates.io/crates/datafusion-forecast)

Forecasts with Mistral AI's [Timestral](https://github.com/mistralai/timestral) models as an
[Apache DataFusion](https://datafusion.apache.org) aggregate function. The model runs in Rust on top of the
[`candle-timestral`](https://github.com/nfnt/datafusion-forecast/tree/main/crates/candle-timestral) crate.
Expand Down
Loading