Struct KeyRemapper 

pub struct KeyRemapper {
    pub patterns: Vec<(Regex, String)>,
}

Key remapper for transforming tensor names.

This allows mapping tensor names from one naming convention to another, which is useful for loading models from different frameworks or versions.

Examples

// Create a key remapper
let remapper = KeyRemapper::new()
    .add_pattern(r"^pytorch\.(.*)", "burn.$1").expect("valid regex")  // pytorch.layer -> burn.layer
    .add_pattern(r"\.gamma$", ".weight").expect("valid regex");       // layer.gamma -> layer.weight

// Use remapper with stores
// store.remap(remapper)

Fields

patterns: Vec<(Regex, String)>

Pattern-based remapping rules (regex pattern, replacement string)

Implementations

impl KeyRemapper

pub fn new() -> Self

Create a new empty key remapper

pub fn add_pattern<S1, S2>(self, from: S1, to: S2) -> Result<Self, Error>

where S1: AsRef<str>, S2: Into<String>,

Add a remapping pattern (compiles regex)

Arguments

• from - Source pattern (regex string)
• to - Replacement string (can include capture groups like $1)

Returns

• Ok(Self) - Updated remapping configuration
• Err(regex::Error) - If regex compilation fails

pub fn from_compiled_patterns(patterns: Vec<(Regex, String)>) -> Self

Create from a list of compiled regex patterns

pub fn from_patterns<S1, S2>(patterns: Vec<(S1, S2)>) -> Result<Self, Error>

where S1: AsRef<str>, S2: Into<String>,

Create from string patterns (will compile to regex)

Arguments

• patterns - Vector of (pattern, replacement) tuples

Returns

• Ok(Self) - New remapping configuration
• Err(regex::Error) - If any regex compilation fails

pub fn from_pattern_iter<I, S1, S2>(iter: I) -> Result<Self, Error>

where I: IntoIterator<Item = (S1, S2)>, S1: AsRef<str>, S2: Into<String>,

Create from an iterator of patterns

Arguments

• iter - Iterator yielding (pattern, replacement) tuples

Returns

• Ok(Self) - New remapping configuration
• Err(regex::Error) - If any regex compilation fails

pub fn is_empty(&self) -> bool

Check if the remapping is empty

pub fn to_regex_pairs(&self) -> Vec<(Regex, String)>

Convert to the format expected by remap_tensor_paths_with_patterns

pub fn remap( &self, tensors: Vec<TensorSnapshot>, ) -> (Vec<TensorSnapshot>, Vec<(String, String)>)

Remap tensor paths using the configured patterns.

Arguments

• tensors - Vec of TensorSnapshots to remap

Returns

A tuple containing:

• The remapped Vec of TensorSnapshots with updated paths
• A vector of (new_path, original_path) showing the transformations

Trait Implementations

impl Clone for KeyRemapper

fn clone(&self) -> KeyRemapper

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyRemapper

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

Formats the value using the given formatter.

impl Default for KeyRemapper

fn default() -> KeyRemapper

Returns the “default value” for a type.