Struct candle_nn::var_map::VarMap

pub struct VarMap { /* private fields */ }

A VarMap is a store that holds named variables. Variables can be retrieved from the stores and new variables can be added by providing some initialization config in case they are missing. VarMap structures can be serialized in the safetensors format.

Implementations

impl VarMap

pub fn new() -> Self

Create a new empty VarMap.

pub fn all_vars(&self) -> Vec<Var>

Retrieve all the variables currently stored in the map.

pub fn save<P: AsRef<Path>>(&self, path: P) -> Result<()>

Save the map in the safetensors format.

pub fn load<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Load some values from a safetensors file and modify the existing variables to have these values.

Note that values for variables that are currently not in the map are not kept.

pub fn set_one<K: AsRef<str>, V: AsRef<Tensor>>( &mut self, name: K, value: V ) -> Result<()>

Set a named variable to some value.

pub fn set<I: Iterator<Item = (K, V)>, K: AsRef<str>, V: AsRef<Tensor>>( &mut self, iter: I ) -> Result<()>

Set some named variables to some values.

If an error is returned, some of the variables might have already been set to their new values.

pub fn get<S: Into<Shape>>( &self, shape: S, path: &str, init: Init, dtype: DType, device: &Device ) -> Result<Tensor>

Retrieve or add a new variable.

pub fn data(&self) -> &Mutex<HashMap<String, Var>>

Trait Implementations

impl Clone for VarMap

fn clone(&self) -> VarMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl SimpleBackend for VarMap

fn get( &self, s: Shape, name: &str, h: Init, dtype: DType, dev: &Device ) -> Result<Tensor>

Retrieve a tensor based on a target name and shape.

fn contains_tensor(&self, name: &str) -> bool