Struct ParamGroup 

pub struct ParamGroup { /* private fields */ }

A way to represent a group of parameter for a Burn module.

Implementations

impl ParamGroup

pub fn matches(&self, id: &ParamId, path: Option<&str>) -> bool

Evaluates whether a given parameter ID and its module path match this group.

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

Returns a parameter group with all of the module’s parameters.

pub fn from_path(path: impl Into<String>) -> Self

Matches parameters by exact text path (e.g., “model.backbone.linear.weight”)

pub fn from_paths(paths: Vec<impl Into<String>>) -> Self

Matches parameters by exact text paths (e.g., “model.backbone.linear.weight”, etc.)

pub fn from_predicate(path: impl Into<String>) -> Self

Matches parameters that include the predicate in their paths (e.g., “backbone”)

pub fn from_predicates(paths: Vec<impl Into<String>>) -> Self

Matches parameters that include all the predicates in their path (AND logic). (e.g., parameter path contains “backbone” and “linear”)

pub fn from_any_predicates(paths: Vec<impl Into<String>>) -> Self

Matches parameters that include any of the predicates in their path (OR logic). (e.g., parameter path contains “backbone” or “linear”)

pub fn from_regex<S: AsRef<str>>(pattern: S) -> Result<Self, ParamGroupError>

Available on crate feature std only.

Matches parameters by regex pattern (e.g., “^model.layer.\d+$”)

Errors

Returns a ParamGroupError::InvalidPatternError if the string cannot be compiled into a valid regex.

pub fn from_regexes<S: AsRef<str>>( patterns: Vec<S>, ) -> Result<Self, ParamGroupError>

Available on crate feature std only.

Matches parameters for all the regex patterns (AND logic). (e.g., “^encoder.layer.\d+”, and “bias$” )

Errors

Returns a ParamGroupError::InvalidPatternError if the strings cannot be compiled into a valid regex.

pub fn from_any_regexes<S: AsRef<str>>( patterns: Vec<S>, ) -> Result<Self, ParamGroupError>

Available on crate feature std only.

Matches parameters for any the regex patterns (OR logic). (e.g., “^encoder.layer.\d+$”, or “^decoder.layer.\d+$” )

Errors

Returns a ParamGroupError::InvalidPatternError if the strings cannot be compiled into a valid regex.

pub fn all() -> Self

Matches any parameter.

pub fn from_ids(ids: Vec<ParamId>) -> Self

Matches a specific slice of predefined parameter IDs.

pub fn fuse(self, other: &Self) -> Self

Fuse two parameter group.

pub fn exclude(self, group: Self) -> Self

Exclude the given group from the current group

Trait Implementations

impl Clone for ParamGroup

fn clone(&self) -> ParamGroup

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamGroup

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParamGroup

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ParamGroup

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

where __S: Serializer,

Serialize this value into the given Serde serializer.