Struct WarmupTracker 

pub struct WarmupTracker { /* private fields */ }

Bounded-memory warmup state tracker.

Tracks the number of observed samples, the most recent absolute error, and a baseline error. From these it derives a WarmupState.

Examples

use rill_ml::diagnostics::WarmupTracker;

let mut tracker = WarmupTracker::default();
assert_eq!(tracker.state().as_str(), "no_data");

for _ in 0..5 {
    tracker.observe_sample(None).unwrap();
}
assert!(tracker.state().is_ready());

Implementations

impl WarmupTracker

pub fn new(config: WarmupConfig) -> Result<Self, RillError>

Create a new tracker with the given configuration.

Returns RillError::InvalidParameter if the thresholds are not ordered warming_up_threshold < usable_threshold <= stable_threshold or if degraded_error_ratio is not greater than 1.0.

pub fn observe_sample(&mut self, error: Option<f64>) -> Result<(), RillError>

Observe a sample, optionally with an error value.

When error is Some, the value must be finite; its absolute value replaces the stored recent error. When error is None, only the sample counter is incremented.

Returns RillError::NonFiniteValue if error is Some but not finite. In that case the tracker state is left unchanged.

pub fn set_baseline(&mut self, baseline: f64) -> Result<(), RillError>

Set the baseline error for comparison.

The absolute value is stored, so signed errors are accepted.

pub fn state(&self) -> WarmupState

Compute the current warmup state.

The decision is made in priority order:

1. No samples seen → WarmupState::NoData.
2. Samples below warming_up_threshold → WarmupState::WarmingUp.
3. If both recent and baseline errors are available:
   • recent > baseline × degraded_error_ratio → WarmupState::Degraded.
   • samples ≥ stable_threshold and recent ≤ baseline → WarmupState::Stable.
4. Otherwise → WarmupState::Usable.

pub const fn samples(&self) -> u64

Number of samples observed so far.

pub const fn recent_error(&self) -> Option<f64>

The most recent absolute error, or None if none was recorded.

pub const fn baseline_error(&self) -> Option<f64>

The baseline error, or None if not set.

pub fn reset(&mut self)

Reset the tracker to its initial (no-data) state.

Trait Implementations

impl Clone for WarmupTracker

fn clone(&self) -> WarmupTracker

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WarmupTracker

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

Formats the value using the given formatter.

impl Default for WarmupTracker

fn default() -> Self

Returns the “default value” for a type.