pub struct StreamingMultiOutput<S = Untrained> { /* private fields */ }Expand description
Streaming Multi-Output Learner
Handles streaming data with mini-batch processing and concept drift detection.
§Examples
use sklears_multioutput::streaming::{StreamingMultiOutput, StreamingMultiOutputConfig};
// Use SciRS2-Core for arrays and random number generation (SciRS2 Policy)
use scirs2_core::ndarray::array;
use sklears_core::traits::{Fit, Predict};
let X = array![[1.0, 2.0], [2.0, 3.0], [3.0, 4.0]];
let y = array![[1.0, 2.0], [2.0, 3.0], [3.0, 4.0]];
let mut model = StreamingMultiOutput::new()
.batch_size(2)
.learning_rate(0.1);
let trained = model.fit(&X.view(), &y.view()).unwrap();
// Add streaming data
let X_stream = array![[4.0, 5.0]];
let y_stream = array![[4.0, 5.0]];
let updated = trained.update_stream(&X_stream.view(), &y_stream.view()).unwrap();
let predictions = updated.predict(&X.view()).unwrap();
assert_eq!(predictions.dim(), (3, 2));Implementations§
Source§impl StreamingMultiOutput<Untrained>
impl StreamingMultiOutput<Untrained>
Sourcepub fn config(self, config: StreamingMultiOutputConfig) -> Self
pub fn config(self, config: StreamingMultiOutputConfig) -> Self
Set the configuration
Sourcepub fn batch_size(self, batch_size: usize) -> Self
pub fn batch_size(self, batch_size: usize) -> Self
Set the batch size
Sourcepub fn learning_rate(self, lr: Float) -> Self
pub fn learning_rate(self, lr: Float) -> Self
Set the learning rate
Sourcepub fn detect_drift(self, detect: bool) -> Self
pub fn detect_drift(self, detect: bool) -> Self
Enable/disable drift detection
Source§impl StreamingMultiOutput<StreamingMultiOutputTrained>
impl StreamingMultiOutput<StreamingMultiOutputTrained>
Sourcepub fn update_stream(
self,
X: &ArrayView2<'_, Float>,
y: &ArrayView2<'_, Float>,
) -> SklResult<Self>
pub fn update_stream( self, X: &ArrayView2<'_, Float>, y: &ArrayView2<'_, Float>, ) -> SklResult<Self>
Update with streaming data
Sourcepub fn flush_buffer(self) -> SklResult<Self>
pub fn flush_buffer(self) -> SklResult<Self>
Force processing of remaining buffer
Sourcepub fn drift_detected(&self) -> bool
pub fn drift_detected(&self) -> bool
Check if drift was detected
Sourcepub fn n_drift_events(&self) -> usize
pub fn n_drift_events(&self) -> usize
Get number of drift events
Sourcepub fn buffer_size(&self) -> usize
pub fn buffer_size(&self) -> usize
Get buffer size
Trait Implementations§
Source§impl<S: Clone> Clone for StreamingMultiOutput<S>
impl<S: Clone> Clone for StreamingMultiOutput<S>
Source§fn clone(&self) -> StreamingMultiOutput<S>
fn clone(&self) -> StreamingMultiOutput<S>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<S: Debug> Debug for StreamingMultiOutput<S>
impl<S: Debug> Debug for StreamingMultiOutput<S>
Source§impl Default for StreamingMultiOutput<Untrained>
impl Default for StreamingMultiOutput<Untrained>
Source§impl Estimator for StreamingMultiOutput<Untrained>
impl Estimator for StreamingMultiOutput<Untrained>
Source§type Config = StreamingMultiOutputConfig
type Config = StreamingMultiOutputConfig
Configuration type for the estimator
Source§type Error = SklearsError
type Error = SklearsError
Error type for the estimator
Source§fn validate_config(&self) -> Result<(), SklearsError>
fn validate_config(&self) -> Result<(), SklearsError>
Validate estimator configuration with detailed error context
Source§fn check_compatibility(
&self,
n_samples: usize,
n_features: usize,
) -> Result<(), SklearsError>
fn check_compatibility( &self, n_samples: usize, n_features: usize, ) -> Result<(), SklearsError>
Check if estimator is compatible with given data dimensions
Source§fn metadata(&self) -> EstimatorMetadata
fn metadata(&self) -> EstimatorMetadata
Get estimator metadata
Source§impl Estimator for StreamingMultiOutput<StreamingMultiOutputTrained>
impl Estimator for StreamingMultiOutput<StreamingMultiOutputTrained>
Source§type Config = StreamingMultiOutputConfig
type Config = StreamingMultiOutputConfig
Configuration type for the estimator
Source§type Error = SklearsError
type Error = SklearsError
Error type for the estimator
Source§fn validate_config(&self) -> Result<(), SklearsError>
fn validate_config(&self) -> Result<(), SklearsError>
Validate estimator configuration with detailed error context
Source§fn check_compatibility(
&self,
n_samples: usize,
n_features: usize,
) -> Result<(), SklearsError>
fn check_compatibility( &self, n_samples: usize, n_features: usize, ) -> Result<(), SklearsError>
Check if estimator is compatible with given data dimensions
Source§fn metadata(&self) -> EstimatorMetadata
fn metadata(&self) -> EstimatorMetadata
Get estimator metadata
Source§impl Fit<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>> for StreamingMultiOutput<Untrained>
impl Fit<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>> for StreamingMultiOutput<Untrained>
Source§type Fitted = StreamingMultiOutput<StreamingMultiOutputTrained>
type Fitted = StreamingMultiOutput<StreamingMultiOutputTrained>
The fitted model type
Source§fn fit(
self,
X: &ArrayView2<'_, Float>,
y: &ArrayView2<'_, Float>,
) -> SklResult<Self::Fitted>
fn fit( self, X: &ArrayView2<'_, Float>, y: &ArrayView2<'_, Float>, ) -> SklResult<Self::Fitted>
Fit the model to the provided data with validation
Source§fn fit_with_validation(
self,
x: &X,
y: &Y,
_x_val: Option<&X>,
_y_val: Option<&Y>,
) -> Result<(Self::Fitted, FitMetrics), SklearsError>where
Self: Sized,
fn fit_with_validation(
self,
x: &X,
y: &Y,
_x_val: Option<&X>,
_y_val: Option<&Y>,
) -> Result<(Self::Fitted, FitMetrics), SklearsError>where
Self: Sized,
Fit with custom validation and early stopping
Source§impl Predict<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>> for StreamingMultiOutput<StreamingMultiOutputTrained>
impl Predict<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>> for StreamingMultiOutput<StreamingMultiOutputTrained>
Source§fn predict(&self, X: &ArrayView2<'_, Float>) -> SklResult<Array2<Float>>
fn predict(&self, X: &ArrayView2<'_, Float>) -> SklResult<Array2<Float>>
Make predictions on the provided data
Source§fn predict_with_uncertainty(
&self,
x: &X,
) -> Result<(Output, UncertaintyMeasure), SklearsError>
fn predict_with_uncertainty( &self, x: &X, ) -> Result<(Output, UncertaintyMeasure), SklearsError>
Make predictions with confidence intervals
Auto Trait Implementations§
impl<S> Freeze for StreamingMultiOutput<S>where
S: Freeze,
impl<S> RefUnwindSafe for StreamingMultiOutput<S>where
S: RefUnwindSafe,
impl<S> Send for StreamingMultiOutput<S>where
S: Send,
impl<S> Sync for StreamingMultiOutput<S>where
S: Sync,
impl<S> Unpin for StreamingMultiOutput<S>where
S: Unpin,
impl<S> UnwindSafe for StreamingMultiOutput<S>where
S: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> StableApi for Twhere
T: Estimator,
impl<T> StableApi for Twhere
T: Estimator,
Source§const STABLE_SINCE: &'static str = "0.1.0"
const STABLE_SINCE: &'static str = "0.1.0"
API version this type was stabilized in
Source§const HAS_EXPERIMENTAL_FEATURES: bool = false
const HAS_EXPERIMENTAL_FEATURES: bool = false
Whether this API has any experimental features