Struct StateDict 

pub struct StateDict { /* private fields */ }

State dictionary for storing model parameters.

This is similar to PyTorch’s state_dict, mapping parameter names to tensors.

Implementations

impl StateDict

pub fn new() -> Self

Create an empty state dictionary.

pub fn from_module<M: Module>(module: &M) -> Self

Create a state dictionary from a module.

pub fn insert(&mut self, name: String, data: TensorData)

Insert a tensor into the state dictionary.

pub fn insert_entry(&mut self, name: String, entry: StateDictEntry)

Insert an entry into the state dictionary.

pub fn get(&self, name: &str) -> Option<&StateDictEntry>

Get an entry by name.

pub fn get_mut(&mut self, name: &str) -> Option<&mut StateDictEntry>

Get a mutable entry by name.

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

Check if the state dictionary contains a key.

pub fn len(&self) -> usize

Get the number of entries.

pub fn is_empty(&self) -> bool

Check if the state dictionary is empty.

pub fn keys(&self) -> impl Iterator<Item = &String>

Get all keys.

pub fn entries(&self) -> impl Iterator<Item = (&String, &StateDictEntry)>

Get all entries.

pub fn remove(&mut self, name: &str) -> Option<StateDictEntry>

Remove an entry.

pub fn merge(&mut self, other: StateDict)

Merge another state dictionary into this one.

pub fn filter_prefix(&self, prefix: &str) -> StateDict

Get a subset of entries matching a prefix.

pub fn strip_prefix(&self, prefix: &str) -> StateDict

Strip a prefix from all keys.

pub fn add_prefix(&self, prefix: &str) -> StateDict

Add a prefix to all keys.

pub fn set_metadata(&mut self, key: &str, value: &str)

Set metadata on the state dictionary.

pub fn get_metadata(&self, key: &str) -> Option<&String>

Get metadata from the state dictionary.

pub fn total_params(&self) -> usize

Get total number of parameters (elements across all tensors).

pub fn size_bytes(&self) -> usize

Get total size in bytes.

pub fn summary(&self) -> String

Print a summary of the state dictionary.

Trait Implementations

impl Clone for StateDict

fn clone(&self) -> StateDict

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StateDict

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

Formats the value using the given formatter.

impl Default for StateDict

fn default() -> StateDict

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StateDict

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StateDict

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.