Skip to main content

ModuleBase

Struct ModuleBase 

Source
pub struct ModuleBase {
    pub parameters: HashMap<String, Parameter>,
    /* private fields */
}
Expand description

Base module implementation helper

Fields§

§parameters: HashMap<String, Parameter>

Implementations§

Source§

impl ModuleBase

Source

pub fn new() -> Self

Source

pub fn training(&self) -> bool

Check if in training mode

Source

pub fn set_training(&mut self, training: bool)

Set training mode

Source

pub fn apply_to_parameters<F>(&mut self, f: F) -> Result<()>
where F: Fn(&mut Parameter) -> Result<()>,

Apply function to all parameters in this module

Source

pub fn apply_to_modules<F>(&mut self, f: F) -> Result<()>
where F: Fn(&mut dyn Module) -> Result<()>,

Apply function to all modules recursively

Source

pub fn children(&self) -> Vec<&dyn Module>

Get children modules as references

Source

pub fn named_children(&self) -> Vec<(String, &dyn Module)>

Get named children modules

Source

pub fn named_parameters(&self) -> HashMap<String, Parameter>

Get named parameters

Source

pub fn to_device(&mut self, device: DeviceType) -> Result<()>

Move to device

Source

pub fn register_parameter(&mut self, name: String, param: Parameter)

Register a parameter

Source

pub fn register_buffer(&mut self, name: String, tensor: Tensor)

Register a buffer

Source

pub fn register_module(&mut self, name: String, module: Box<dyn Module>)

Register a submodule

Source

pub fn all_parameter_tensors(&self) -> Vec<Arc<RwLock<Tensor>>>

Get all parameters including submodules (legacy method)

Source

pub fn get_all_named_parameters(&self) -> HashMap<String, Parameter>

Get all parameters with module hierarchical names

Source

pub fn all_named_parameters(&self) -> HashMap<String, Arc<RwLock<Tensor>>>

Get all named parameters including submodules

Source

pub fn register_hook( &mut self, hook_type: HookType, callback: HookCallback, ) -> HookHandle

Register a hook for this module

Source

pub fn remove_hook(&mut self, hook_type: HookType, handle: HookHandle) -> bool

Remove a hook by handle

Source

pub fn execute_hooks( &self, hook_type: HookType, module: &dyn Module, input: &Tensor, output: Option<&Tensor>, ) -> Result<()>

Execute hooks of a specific type

Source

pub fn has_hooks(&self, hook_type: HookType) -> bool

Check if any hooks are registered

Source

pub fn hook_count(&self, hook_type: HookType) -> usize

Get hook count for a specific type

Source

pub fn clear_hooks(&mut self, hook_type: HookType)

Clear all hooks of a specific type

Source

pub fn clear_all_hooks(&mut self)

Clear all hooks

Trait Implementations§

Source§

impl Debug for ModuleBase

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ModuleBase

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V