pub struct StructuredVariationalGMM<S = Untrained> { /* private fields */ }Expand description
Structured Variational Gaussian Mixture Model
This implementation uses structured variational approximations that preserve certain dependencies between latent variables, providing more accurate posterior approximations than mean-field while remaining computationally tractable.
The key idea is to use a structured approximation of the form: q(θ, z) = q(π, μ, Λ | z) q(z) where some dependencies are preserved within each factor.
§Examples
use sklears_mixture::{StructuredVariationalGMM, StructuredFamily, CovarianceType};
use sklears_core::traits::{Predict, Fit};
use scirs2_core::ndarray::array;
let X = array![[0.0, 0.0], [1.0, 1.0], [2.0, 2.0], [10.0, 10.0], [11.0, 11.0], [12.0, 12.0]];
let model = StructuredVariationalGMM::new()
.n_components(2)
.structured_family(StructuredFamily::MeanPrecision)
.covariance_type(CovarianceType::Full);
let fitted = model.fit(&X.view(), &()).unwrap();
let labels = fitted.predict(&X.view()).unwrap();Implementations§
Source§impl StructuredVariationalGMM<Untrained>
impl StructuredVariationalGMM<Untrained>
Sourcepub fn n_components(self, n_components: usize) -> Self
pub fn n_components(self, n_components: usize) -> Self
Set the number of components
Sourcepub fn structured_family(self, family: StructuredFamily) -> Self
pub fn structured_family(self, family: StructuredFamily) -> Self
Set the structured approximation family
Sourcepub fn covariance_type(self, covariance_type: CovarianceType) -> Self
pub fn covariance_type(self, covariance_type: CovarianceType) -> Self
Set the covariance type
Sourcepub fn random_state(self, random_state: u64) -> Self
pub fn random_state(self, random_state: u64) -> Self
Set the random state
Sourcepub fn weight_concentration(self, weight_concentration: f64) -> Self
pub fn weight_concentration(self, weight_concentration: f64) -> Self
Set the weight concentration parameter
Sourcepub fn mean_precision(self, mean_precision: f64) -> Self
pub fn mean_precision(self, mean_precision: f64) -> Self
Set the mean precision parameter
Sourcepub fn degrees_of_freedom(self, degrees_of_freedom: f64) -> Self
pub fn degrees_of_freedom(self, degrees_of_freedom: f64) -> Self
Set the degrees of freedom parameter
Sourcepub fn init_method(self, init_method: InitMethod) -> Self
pub fn init_method(self, init_method: InitMethod) -> Self
Set the initialization method
Sourcepub fn max_coord_steps(self, max_coord_steps: usize) -> Self
pub fn max_coord_steps(self, max_coord_steps: usize) -> Self
Set the maximum number of coordinate ascent steps
Trait Implementations§
Source§impl<S: Clone> Clone for StructuredVariationalGMM<S>
impl<S: Clone> Clone for StructuredVariationalGMM<S>
Source§fn clone(&self) -> StructuredVariationalGMM<S>
fn clone(&self) -> StructuredVariationalGMM<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 StructuredVariationalGMM<S>
impl<S: Debug> Debug for StructuredVariationalGMM<S>
Source§impl Default for StructuredVariationalGMM<Untrained>
impl Default for StructuredVariationalGMM<Untrained>
Source§impl Estimator for StructuredVariationalGMM<Untrained>
impl Estimator for StructuredVariationalGMM<Untrained>
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]>>, ()> for StructuredVariationalGMM<Untrained>
impl Fit<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ()> for StructuredVariationalGMM<Untrained>
Source§type Fitted = StructuredVariationalGMMTrained
type Fitted = StructuredVariationalGMMTrained
The fitted model type
Source§fn fit(self, X: &ArrayView2<'_, f64>, _y: &()) -> SklResult<Self::Fitted>
fn fit(self, X: &ArrayView2<'_, f64>, _y: &()) -> 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
Auto Trait Implementations§
impl<S> Freeze for StructuredVariationalGMM<S>where
S: Freeze,
impl<S> RefUnwindSafe for StructuredVariationalGMM<S>where
S: RefUnwindSafe,
impl<S> Send for StructuredVariationalGMM<S>where
S: Send,
impl<S> Sync for StructuredVariationalGMM<S>where
S: Sync,
impl<S> Unpin for StructuredVariationalGMM<S>where
S: Unpin,
impl<S> UnwindSafe for StructuredVariationalGMM<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