reve_rs/lib.rs
1//! # reve-rs — REVE EEG Foundation Model inference in Rust
2//!
3//! Pure-Rust inference for the REVE (Representation for EEG with Versatile
4//! Embeddings) foundation model, built on [Burn 0.20](https://burn.dev).
5//!
6//! REVE is a pretrained EEG model that generalizes across diverse electrode
7//! configurations using 4D positional encoding (x, y, z, t). It was pretrained
8//! on 60,000+ hours of EEG data from 92 datasets spanning 25,000 subjects.
9//!
10//! ## Quick start
11//!
12//! ```rust,ignore
13//! use reve_rs::ReveEncoder;
14//!
15//! let (model, _ms) = ReveEncoder::<B>::load(
16//! Path::new("config.json"),
17//! Path::new("model.safetensors"),
18//! device,
19//! )?;
20//! ```
21
22pub mod config;
23pub mod data;
24pub mod encoder;
25pub mod model;
26pub mod position_bank;
27pub mod weights;
28
29// Flat re-exports
30pub use config::ModelConfig;
31pub use data::{InputBatch, build_batch, build_batch_named};
32pub use encoder::{ReveEncoder, ReveOutput, EncodingResult};
33pub use position_bank::PositionBank;
34pub use weights::WeightMap;