Skip to main content

PrequentialEvaluator

Struct PrequentialEvaluator 

Source
pub struct PrequentialEvaluator { /* private fields */ }
Expand description

Prequential (test-then-train) evaluator for streaming regression models.

For each sample:

  1. Predict – query the model before it sees this sample.
  2. Record – update metrics with (target, prediction) if past warmup and on the evaluation step interval.
  3. Train – feed the sample to the model.

This ensures the model is always evaluated on unseen data, which is the correct methodology for streaming ML (as opposed to train-then-test which leaks information).

§Metric Backends

§Example

use irithyll::evaluation::{PrequentialEvaluator, PrequentialConfig};
use irithyll::learner::{SGBTLearner, StreamingLearner};
use irithyll::SGBTConfig;

let config = SGBTConfig::builder()
    .n_steps(5)
    .learning_rate(0.1)
    .grace_period(10)
    .build()
    .unwrap();
let mut model = SGBTLearner::from_config(config);

let mut eval = PrequentialEvaluator::new()
    .with_rolling_window(50)
    .with_ewma(20);

// Simulate a data stream
for i in 0..200 {
    let x = [i as f64, (i as f64).sin()];
    let y = i as f64 * 0.5 + 1.0;
    eval.step(&mut model, &x, y);
}

assert!(eval.regression_metrics().n_samples() > 0);

Implementations§

Source§

impl PrequentialEvaluator

Source

pub fn new() -> Self

Create a new evaluator with default configuration (warmup=0, step_interval=1).

Source

pub fn with_config(config: PrequentialConfig) -> Self

Create a new evaluator with the given configuration.

Source

pub fn with_rolling_window(self, window_size: usize) -> Self

Enable rolling (windowed) regression metrics.

Metrics will be computed over the last window_size evaluated samples.

§Panics

Panics if window_size is zero.

Source

pub fn with_ewma(self, span: usize) -> Self

Enable EWMA (exponentially weighted) regression metrics.

The decay factor is alpha = 2 / (span + 1).

§Panics

Panics if span is zero.

Source

pub fn step( &mut self, model: &mut dyn StreamingLearner, features: &[f64], target: f64, ) -> f64

Process a single sample through the test-then-train protocol.

  1. Predict using the current model state.
  2. If past warmup and on the step interval, record metrics.
  3. Train the model on this sample.
  4. Return the prediction (made before training).

The model always trains on every sample, regardless of warmup or step interval. Only metric recording is gated.

Source

pub fn evaluate<O: Observation>( &mut self, model: &mut dyn StreamingLearner, data: &[O], )

Run the full test-then-train protocol over a slice of observations.

Iterates over data, calling step for each observation.

Source

pub fn regression_metrics(&self) -> &RegressionMetrics

Reference to the cumulative regression metrics.

Source

pub fn rolling_metrics(&self) -> Option<&RollingRegressionMetrics>

Reference to the rolling regression metrics, if enabled.

Source

pub fn ewma_metrics(&self) -> Option<&EwmaRegressionMetrics>

Reference to the EWMA regression metrics, if enabled.

Source

pub fn samples_seen(&self) -> u64

Total number of samples processed (both warmup and evaluated).

Source

pub fn samples_evaluated(&self) -> u64

Number of samples that were actually evaluated (past warmup, on step interval).

Source

pub fn reset(&mut self)

Reset all metrics and counters to the initial state.

Configuration (warmup, step_interval, rolling window, EWMA span) is preserved.

Trait Implementations§

Source§

impl Clone for PrequentialEvaluator

Source§

fn clone(&self) -> PrequentialEvaluator

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PrequentialEvaluator

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for PrequentialEvaluator

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,