Struct sbr::models::ewma::Hyperparameters

pub struct Hyperparameters { /* fields omitted */ }

Hyperparameters describing the EWMA model.

Methods

impl Hyperparameters

pub fn new(num_items: usize, max_sequence_length: usize) -> Self

Build new hyperparameters.

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

Set the learning rate.

pub fn l2_penalty(self, l2_penalty: f32) -> Self

Set the L2 penalty.

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

Set the embedding dimensionality.

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

Set the number of epochs to run per each fit call.

pub fn loss(self, loss: Loss) -> Self

Set the loss function.

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

Set number of threads to be used.

pub fn parallelism(self, parallelism: Parallelism) -> Self

Set the type of paralellism.

pub fn rng(self, rng: XorShiftRng) -> Self

Set the random number generator.

pub fn from_seed(self, seed: [u8; 16]) -> Self

Set the random number generator from seed.

pub fn optimizer(self, optimizer: Optimizer) -> Self

Set the optimizer type.

pub fn random<R: Rng>(num_items: usize, rng: &mut R) -> Self

Set hyperparameters randomly: useful for hyperparameter search.

pub fn build(self) -> ImplicitEWMAModel

Build the implicit EWMA model.

Trait Implementations

impl Clone for Hyperparameters

fn clone(&self) -> Hyperparameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hyperparameters

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

Formats the value using the given formatter.