pub trait ModuleParameters {
// Required methods
fn parameters(&self) -> ModuleParamRef<'_>;
fn parameters_mut(&mut self) -> ModuleParamMut<'_>;
fn trainable_parameters(&self) -> ModuleParamRef<'_>;
fn freeze_parameters(&mut self, recursive: bool);
fn unfreeze_parameters(&mut self, recursive: bool);
fn all_frozen(&self) -> Option<bool>;
fn any_frozen(&self) -> Option<bool>;
// Provided methods
fn update(&mut self, parameters: ModuleParam) { ... }
fn update_flattened(&mut self, flattened_parameters: FlattenedModuleParam) { ... }
}
Expand description
Trait for accessing and updating module parameters.
Required Methods§
Sourcefn parameters(&self) -> ModuleParamRef<'_>
fn parameters(&self) -> ModuleParamRef<'_>
Get references to the module parameters.
Sourcefn parameters_mut(&mut self) -> ModuleParamMut<'_>
fn parameters_mut(&mut self) -> ModuleParamMut<'_>
Get mutable references to the module parameters.
Sourcefn trainable_parameters(&self) -> ModuleParamRef<'_>
fn trainable_parameters(&self) -> ModuleParamRef<'_>
Get references to the trainable parameters. A parameter is trainable if it is NOT frozen.
Sourcefn freeze_parameters(&mut self, recursive: bool)
fn freeze_parameters(&mut self, recursive: bool)
Freeze all parameters in the module.
Sourcefn unfreeze_parameters(&mut self, recursive: bool)
fn unfreeze_parameters(&mut self, recursive: bool)
Unfreeze all parameters in the module.
Sourcefn all_frozen(&self) -> Option<bool>
fn all_frozen(&self) -> Option<bool>
Check if all parameters in the module are frozen. Returns None
if there are no parameters.
Sourcefn any_frozen(&self) -> Option<bool>
fn any_frozen(&self) -> Option<bool>
Check if any parameter in the module is frozen. Returns None
if there are no parameters.
Provided Methods§
Sourcefn update(&mut self, parameters: ModuleParam)
fn update(&mut self, parameters: ModuleParam)
Update the module parameters.
Sourcefn update_flattened(&mut self, flattened_parameters: FlattenedModuleParam)
fn update_flattened(&mut self, flattened_parameters: FlattenedModuleParam)
Update the module parameters from a flattened representation.