Module module

Source
Expand description

This mod defines the traits for neural network modules and parameters.

This is to separate the trait definitions from the implementations, which are in the mlx-nn crate. This also allows using the mlx_macros::ModuleParameters derive macro in crates other than mlx-nn.

Structs§

Param
A simple wrapper for a module parameter.

Traits§

Module
Trait for a neural network module.
ModuleParameters
Trait for accessing and updating module parameters.
ModuleParametersExt
Extension trait for ModuleParameters. This is implemented for all types that implement ModuleParameters.
Parameter
Trait for a module parameter.
UnaryModule
Marker trait for a unary neural network module.

Functions§

update_parameters
Update the module parameters from an iterator of (key, value) tuples.

Type Aliases§

FlattenedModuleParam
Type alias for flattened module parameters.
FlattenedModuleParamMut
Type alias for mutably borrowed flattened module parameters.
FlattenedModuleParamRef
Type alias for borrowed flattened module parameters.
ModuleParam
Type alias for owned module parameters.
ModuleParamMut
Type alias for mutably borrowed module parameters.
ModuleParamRef
Type alias for borrowed module parameters.