Struct FeatureSketch 

pub struct FeatureSketch { /* private fields */ }

Sparse feature-name sketch detector for schema-evolving streams.

score() previews the current anomaly score without mutating detector state. update() teaches the detector and advances the internal event counter. Scores are higher for more anomalous events.

Implementations

impl FeatureSketch

pub fn builder() -> FeatureSketchBuilder

Create a builder with the documented default configuration.

pub fn from_config(config: &FeatureSketchConfig) -> Result<Self>

Build directly from config with a random seed.

pub fn from_config_seeded( config: &FeatureSketchConfig, seed: u64, ) -> Result<Self>

Build directly from config with an explicit deterministic seed.

pub fn config(&self) -> &FeatureSketchConfig

Return the detector configuration.

pub fn entries_seen(&self) -> u64

Return the number of processed events.

pub fn is_ready(&self) -> bool

Return true once the detector has processed at least one event.

pub fn score<I, N>(&self, features: I) -> Result<f64>

where I: IntoIterator<Item = (N, f64)>, N: AsRef<str>,

Preview the anomaly score for an event without mutating detector state.

pub fn update<I, N>(&mut self, features: I) -> Result<()>

where I: IntoIterator<Item = (N, f64)>, N: AsRef<str>,

Ingest a feature event without returning its score.

pub fn update_and_score<I, N>(&mut self, features: I) -> Result<f64>

where I: IntoIterator<Item = (N, f64)>, N: AsRef<str>,

Ingest a feature event and return its anomaly score.

This has the same behavior as calling score first and then update with the same feature event. Unlike a literal two-call sequence, this method normalizes and projects the input once.

pub fn to_json(&self) -> Result<String>

Serialize detector state to JSON.

pub fn from_json(json: impl AsRef<[u8]>) -> Result<Self>

Deserialize detector state from JSON previously written by Self::to_json.

pub fn save_json(&self, path: impl AsRef<Path>) -> Result<()>

Serialize detector state to a JSON file.

pub fn load_json(path: impl AsRef<Path>) -> Result<Self>

Deserialize detector state from a JSON file previously written by Self::save_json.

Trait Implementations

impl Clone for FeatureSketch

fn clone(&self) -> FeatureSketch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FeatureSketch

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FeatureSketch

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FeatureSketch

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.