Skip to main content

PredictionReporter

Struct PredictionReporter 

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

Diagnostic wrapper that integrates interval estimation, warmup tracking, and training summary statistics.

Produces a PredictionReport for each prediction without storing raw samples. The underlying model API is not affected: callers feed (prediction, truth) pairs via observe and request a report via report when needed.

§Examples

use rill_ml::diagnostics::PredictionReporter;

let mut reporter = PredictionReporter::default();
reporter.observe(10.0, 11.0).unwrap();
reporter.observe(10.0, 9.0).unwrap();

let report = reporter.report(10.0).unwrap();
assert_eq!(report.prediction(), 10.0);
assert!(report.lower_bound().is_some());
assert_eq!(report.samples_seen(), 2);

Implementations§

Source§

impl PredictionReporter

Source

pub fn new( interval_config: ResidualIntervalConfig, warmup_config: WarmupConfig, summary_config: TrainingSummaryConfig, ) -> Result<Self, RillError>

Create a new reporter with the given configurations.

Each sub-component is constructed independently; configuration errors are propagated as RillError.

Source

pub fn observe(&mut self, prediction: f64, truth: f64) -> Result<(), RillError>

Observe a prediction and its ground truth.

Updates the interval estimator, warmup tracker, and training summary. Non-finite inputs are rejected before any state is mutated.

Source

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

Set the baseline error for comparison.

Propagates to both the warmup tracker and the training summary.

Source

pub fn report(&self, prediction: f64) -> Result<PredictionReport, RillError>

Build an immutable report for the given prediction.

If the interval estimator has insufficient data, the bounds are set to None and no error is returned. Non-finite prediction values are rejected.

Source

pub fn summary(&self) -> &TrainingSummary

Borrow the underlying training summary.

Source

pub fn warmup_state(&self) -> WarmupState

Current warmup state.

Source

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

Recent (EW mean) absolute error, or None if no errors recorded.

Source

pub fn reset(&mut self)

Reset all three sub-components to their initial state.

Trait Implementations§

Source§

impl Clone for PredictionReporter

Source§

fn clone(&self) -> PredictionReporter

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PredictionReporter

Source§

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

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

impl Default for PredictionReporter

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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, 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V