pub struct Autoencoder<State = Untrained> { /* private fields */ }Expand description
Simple Autoencoder model
Implementations§
Source§impl Autoencoder<Untrained>
impl Autoencoder<Untrained>
Sourcepub fn encoding_dim(self, dim: usize) -> Self
pub fn encoding_dim(self, dim: usize) -> Self
Set encoding dimension
Sourcepub fn activation(self, activation: Activation) -> Self
pub fn activation(self, activation: Activation) -> Self
Set activation function
Sourcepub fn learning_rate(self, lr: Float) -> Self
pub fn learning_rate(self, lr: Float) -> Self
Set learning rate
Sourcepub fn batch_size(self, size: usize) -> Self
pub fn batch_size(self, size: usize) -> Self
Set batch size
Sourcepub fn random_state(self, seed: u64) -> Self
pub fn random_state(self, seed: u64) -> Self
Set random state
Sourcepub fn encoder_layers(self, layers: Vec<usize>) -> Self
pub fn encoder_layers(self, layers: Vec<usize>) -> Self
Set encoder layers for deep autoencoder
Sourcepub fn noise_factor(self, factor: Float) -> Self
pub fn noise_factor(self, factor: Float) -> Self
Set noise factor for denoising autoencoder
Sourcepub fn optimizer(self, opt: OptimizerType) -> Self
pub fn optimizer(self, opt: OptimizerType) -> Self
Set optimizer type
Trait Implementations§
Source§impl<State: Clone> Clone for Autoencoder<State>
impl<State: Clone> Clone for Autoencoder<State>
Source§fn clone(&self) -> Autoencoder<State>
fn clone(&self) -> Autoencoder<State>
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<State: Debug> Debug for Autoencoder<State>
impl<State: Debug> Debug for Autoencoder<State>
Source§impl Default for Autoencoder<Untrained>
impl Default for Autoencoder<Untrained>
Source§impl Estimator for Autoencoder<Untrained>
impl Estimator for Autoencoder<Untrained>
Source§type Config = AutoencoderConfig
type Config = AutoencoderConfig
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<OwnedRepr<f64>, Dim<[usize; 2]>>, ()> for Autoencoder<Untrained>
impl Fit<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ()> for Autoencoder<Untrained>
Source§type Fitted = Autoencoder<Trained>
type Fitted = Autoencoder<Trained>
The fitted model type
Source§fn fit(self, x: &Array2<Float>, _y: &()) -> Result<Self::Fitted>
fn fit(self, x: &Array2<Float>, _y: &()) -> Result<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<State> Freeze for Autoencoder<State>
impl<State> RefUnwindSafe for Autoencoder<State>where
State: RefUnwindSafe,
impl<State> Send for Autoencoder<State>where
State: Send,
impl<State> Sync for Autoencoder<State>where
State: Sync,
impl<State> Unpin for Autoencoder<State>where
State: Unpin,
impl<State> UnwindSafe for Autoencoder<State>where
State: 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