Struct KnowledgeDistillation 

pub struct KnowledgeDistillation<S = Untrained> { /* private fields */ }

Knowledge Distillation for Multi-Task Learning

Implements knowledge distillation where a smaller student network learns from a larger teacher network for improved efficiency and performance.

Examples

use sklears_multioutput::transfer_learning::KnowledgeDistillation;
// Use SciRS2-Core for arrays and random number generation (SciRS2 Policy)
use scirs2_core::ndarray::array;

let X = array![[1.0, 2.0], [2.0, 3.0], [3.0, 1.0]];
let y = array![[1.0, 0.0], [0.0, 1.0], [1.0, 1.0]];

let distillation = KnowledgeDistillation::new()
    .temperature(3.0)
    .alpha(0.7)
    .learning_rate(0.01);

Implementations

impl KnowledgeDistillation<Untrained>

pub fn new() -> Self

Create a new KnowledgeDistillation instance

pub fn temperature(self, temp: Float) -> Self

Set the temperature for softening teacher predictions

pub fn alpha(self, alpha: Float) -> Self

Set the alpha parameter for balancing hard and soft targets

pub fn learning_rate(self, lr: Float) -> Self

Set the learning rate

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

Set the maximum number of iterations

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

Set the random state for reproducibility

pub fn fit( &self, X: &ArrayView2<'_, Float>, y: &ArrayView2<'_, Float>, teacher_predictions: &ArrayView2<'_, Float>, ) -> SklResult<KnowledgeDistillation<KnowledgeDistillationTrained>>

Fit the knowledge distillation model

impl KnowledgeDistillation<KnowledgeDistillationTrained>

pub fn predict(&self, X: &ArrayView2<'_, Float>) -> SklResult<Array2<Float>>

Predict using the student network

pub fn student_weights(&self) -> &Array2<Float>

Get the student weights

pub fn teacher_weights(&self) -> &Array2<Float>

Get the teacher weights

Trait Implementations

impl<S: Clone> Clone for KnowledgeDistillation<S>

fn clone(&self) -> KnowledgeDistillation<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for KnowledgeDistillation<S>

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

Formats the value using the given formatter.

impl Default for KnowledgeDistillation<Untrained>

fn default() -> Self

Returns the “default value” for a type.

impl Estimator for KnowledgeDistillation<Untrained>

type Config = ()

Configuration type for the estimator

type Error = SklearsError

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 Estimator for KnowledgeDistillation<KnowledgeDistillationTrained>

type Config = ()

Configuration type for the estimator

type Error = SklearsError

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