SimCLR

Struct SimCLR 

Source
pub struct SimCLR {
    pub projection_dim: usize,
    pub embedding_dim: usize,
    pub temperature: f64,
    pub augmentation_strength: f64,
    pub batch_size: usize,
    pub max_epochs: usize,
    pub learning_rate: f64,
    pub momentum: f64,
    pub labeled_weight: f64,
    pub random_state: Option<u64>,
}
Expand description

SimCLR (A Simple Framework for Contrastive Learning) adaptation for semi-supervised learning

This implements SimCLR’s contrastive learning approach adapted for semi-supervised scenarios. It learns representations by maximizing agreement between differently augmented views of the same data.

§Parameters

  • projection_dim - Dimensionality of projection head (typically smaller than embedding_dim)
  • embedding_dim - Dimensionality of learned embeddings
  • temperature - Temperature parameter for contrastive loss
  • augmentation_strength - Strength of data augmentation
  • batch_size - Batch size for training
  • max_epochs - Maximum number of training epochs
  • learning_rate - Learning rate for optimization
  • momentum - Momentum for exponential moving averages
  • labeled_weight - Weight for supervised contrastive loss component
  • random_state - Random seed for reproducibility

Fields§

§projection_dim: usize

projection_dim

§embedding_dim: usize

embedding_dim

§temperature: f64

temperature

§augmentation_strength: f64

augmentation_strength

§batch_size: usize

batch_size

§max_epochs: usize

max_epochs

§learning_rate: f64

learning_rate

§momentum: f64

momentum

§labeled_weight: f64

labeled_weight

§random_state: Option<u64>

random_state

Implementations§

Source§

impl SimCLR

Source

pub fn new() -> Self

Create a new SimCLR instance

Source

pub fn projection_dim(self, projection_dim: usize) -> Self

Set the projection head dimensionality

Source

pub fn embedding_dim(self, embedding_dim: usize) -> Self

Set the embedding dimensionality

Source

pub fn temperature(self, temperature: f64) -> Self

Set the temperature parameter

Source

pub fn augmentation_strength(self, strength: f64) -> Self

Set the augmentation strength

Source

pub fn batch_size(self, batch_size: usize) -> Self

Set the batch size

Source

pub fn max_epochs(self, max_epochs: usize) -> Self

Set the maximum number of epochs

Source

pub fn learning_rate(self, learning_rate: f64) -> Self

Set the learning rate

Source

pub fn momentum(self, momentum: f64) -> Self

Set the momentum parameter

Source

pub fn labeled_weight(self, labeled_weight: f64) -> Self

Set the labeled weight

Source

pub fn random_state(self, random_state: u64) -> Self

Set the random state

Trait Implementations§

Source§

impl Clone for SimCLR

Source§

fn clone(&self) -> SimCLR

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SimCLR

Source§

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

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

impl Default for SimCLR

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Estimator for SimCLR

Source§

type Config = SimCLR

Configuration type for the estimator
Source§

type Error = ContrastiveLearningError

Error type for the estimator
Source§

type Float = f64

The numeric type used by this estimator
Source§

fn config(&self) -> &Self::Config

Get estimator configuration
Source§

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>

Check if estimator is compatible with given data dimensions
Source§

fn metadata(&self) -> EstimatorMetadata

Get estimator metadata
Source§

impl Fit<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<ViewRepr<&i32>, Dim<[usize; 1]>>> for SimCLR

Source§

type Fitted = FittedSimCLR

The fitted model type
Source§

fn fit( self, X: &ArrayView2<'_, f64>, y: &ArrayView1<'_, i32>, ) -> 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,

Fit with custom validation and early stopping

Auto Trait Implementations§

§

impl Freeze for SimCLR

§

impl RefUnwindSafe for SimCLR

§

impl Send for SimCLR

§

impl Sync for SimCLR

§

impl Unpin for SimCLR

§

impl UnwindSafe for SimCLR

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<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> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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 more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> StableApi for T
where T: Estimator,

Source§

const STABLE_SINCE: &'static str = "0.1.0"

API version this type was stabilized in
Source§

const HAS_EXPERIMENTAL_FEATURES: bool = false

Whether this API has any experimental features
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