Struct ParamRegistry 

pub struct ParamRegistry { /* private fields */ }

Assigns and remembers a stable ParamId for every parameter an optimizer sees.

Cheap to clone and free of interior mutability, so optimizers embedding it stay Clone + Send + Sync.

Implementations

impl ParamRegistry

pub fn new() -> Self

Creates an empty registry.

pub fn len(&self) -> usize

Number of parameters registered so far.

pub fn is_empty(&self) -> bool

Whether no parameter has been registered yet.

pub fn clear(&mut self)

Forgets every registration. Call this alongside clearing optimizer state.

pub fn key(&self, id: ParamId) -> Option<&str>

The canonical state-map key for id, if it has been registered.

pub fn name(&self, id: ParamId) -> Option<&str>

The stable name of id, if it was registered through the named path.

pub fn numel(&self, id: ParamId) -> Option<usize>

The element count recorded for id, if it has been registered.

pub fn id_for_named_tensor( &mut self, name: &str, tensor: &Tensor, ) -> Result<ParamId>

Resolves the id of a parameter identified by a stable caller-supplied name.

The first call for a given name registers it; later calls return the same id regardless of where the tensor lives in memory.

pub fn id_for_named_addr( &mut self, name: &str, addr: usize, numel: usize, ) -> ParamId

Resolves the id for a name plus an already-extracted address / element count.

pub fn id_for_tensor(&mut self, tensor: &Tensor) -> Result<ParamId>

Resolves the id of an anonymous parameter tensor.

See the module documentation for the ordering contract this implies for checkpoint resume.

Errors

Returns an error when a slot restored from a checkpoint is bound to a parameter whose element count does not match, which means the caller is presenting parameters in a different order than the checkpointed run.

pub fn id_for_addr(&mut self, addr: usize, numel: usize) -> Result<ParamId>

Resolves the id for an already-extracted address / element count.

Errors

See ParamRegistry::id_for_tensor.

pub fn rebind(&mut self, id: ParamId, tensor: &Tensor) -> Result<()>

Re-points an existing slot at a new data address.

Optimizers that write results back with Tensor::set_data_f32 — which replaces the underlying buffer rather than mutating it — must call this after the write so the anonymous identity cache keeps tracking the parameter. Optimizers that mutate through iter_mut() keep their address and need not call it.

Errors

Returns an error when id was never registered or the tensor dtype is unsupported.

pub fn key_for_named_tensor( &mut self, name: &str, tensor: &Tensor, ) -> Result<String>

Convenience wrapper returning the canonical state-map key for a named tensor.

Errors

Returns an error for tensor dtypes whose data address cannot be taken.

pub fn key_for_named_addr( &mut self, name: &str, addr: usize, numel: usize, ) -> String

Convenience wrapper returning the canonical state-map key for a named parameter given its address and element count.

pub fn key_for_tensor(&mut self, tensor: &Tensor) -> Result<String>

Convenience wrapper returning the canonical state-map key for a tensor.

This is the direct replacement for the old format!("{:p}", …) idiom.

Errors

See ParamRegistry::id_for_tensor.

pub fn key_for_addr(&mut self, addr: usize, numel: usize) -> Result<String>

Convenience wrapper returning the canonical state-map key for an anonymous parameter given its data address and element count.

Errors

See ParamRegistry::id_for_tensor.

pub fn restore_key(&mut self, key: &str, numel: usize) -> Result<ParamId>

Re-creates the registry slot described by a checkpointed state key.

numel is the length of the restored buffer and is used to validate later bindings. The recreated slot has no address, so the first matching update() of the resuming run claims it.

Errors

Returns an error when key does not use a recognised identity prefix.

pub fn keys(&self) -> Vec<String>

All canonical keys in registration order.

Trait Implementations

impl Clone for ParamRegistry

fn clone(&self) -> ParamRegistry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamRegistry

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

Formats the value using the given formatter.

impl Default for ParamRegistry

fn default() -> ParamRegistry

Returns the “default value” for a type.