Struct Parameters 

pub struct Parameters<'a> { /* private fields */ }

Receives a module’s parameters during Module::visit, with their paths.

Implementations

impl<'a> Parameters<'a>

pub fn new(f: &'a mut dyn FnMut(&str, &mut Array, bool)) -> Self

A visitor calling f(path, parameter, trainable) for each parameter.

pub fn param(&mut self, name: &str, a: &mut Array)

A trainable parameter.

pub fn optional(&mut self, name: &str, a: &mut Option<Array>)

A trainable parameter that may be absent (an optional bias).

pub fn frozen(&mut self, name: &str, a: &mut Array)

A parameter that is never trained (a quantized weight, a LoRA base).

pub fn module<M: Module>(&mut self, name: &str, m: &mut M)

A submodule, whose parameters are named name.….

Examples found in repository

examples/mnist.rs (line 50)

    fn visit(&mut self, p: &mut Parameters<'_>) {
        p.module("layers", &mut self.layers);
    }

pub fn freeze(&mut self, f: impl FnOnce(&mut Self))

Visits f’s parameters as frozen.