Struct ContrastivePredictiveCoding 

pub struct ContrastivePredictiveCoding {
    pub embedding_dim: usize,
    pub hidden_dim: usize,
    pub context_length: usize,
    pub prediction_steps: usize,
    pub temperature: f64,
    pub learning_rate: f64,
    pub batch_size: usize,
    pub max_epochs: usize,
    pub negative_samples: usize,
    pub random_state: Option<u64>,
}

Contrastive Predictive Coding (CPC) for semi-supervised learning

CPC learns representations by predicting future observations from past contexts in a contrastive manner. It maximizes mutual information between contexts and positive samples while minimizing it for negative samples.

Fields

embedding_dim: usize

embedding_dim

hidden_dim: usize

hidden_dim

context_length: usize

context_length

prediction_steps: usize

prediction_steps

temperature: f64

temperature

learning_rate: f64

learning_rate

batch_size: usize

batch_size

max_epochs: usize

max_epochs

negative_samples: usize

negative_samples

random_state: Option<u64>

random_state

Implementations

impl ContrastivePredictiveCoding

pub fn new() -> Self

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for ContrastivePredictiveCoding

fn clone(&self) -> ContrastivePredictiveCoding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContrastivePredictiveCoding

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

Formats the value using the given formatter.

impl Default for ContrastivePredictiveCoding

fn default() -> Self

Returns the “default value” for a type.

impl Estimator for ContrastivePredictiveCoding

type Config = ContrastivePredictiveCoding

Configuration type for the estimator

type Error = ContrastiveLearningError

Error type for the estimator

type Float = f64

The numeric type used by this estimator

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

Get estimator configuration

fn validate_config(&self) -> Result<(), SklearsError>

Validate estimator configuration with detailed error context

fn check_compatibility( &self, n_samples: usize, n_features: usize, ) -> Result<(), SklearsError>

Check if estimator is compatible with given data dimensions

fn metadata(&self) -> EstimatorMetadata

Get estimator metadata

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

type Fitted = FittedContrastivePredictiveCoding

The fitted model type

fn fit( self, X: &ArrayView2<'_, f64>, y: &ArrayView1<'_, i32>, ) -> Result<Self::Fitted>

Fit the model to the provided data with validation

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