Skip to main content

Linear

Struct Linear 

Source
pub struct Linear { /* private fields */ }
Expand description

Fully connected layer: y = xW^T + b

Applies a linear transformation to the incoming data. Weight initialization follows Xavier/Glorot (Glorot & Bengio, 2010).

§Shape

  • Input: (*, in_features) where * means any number of batch dimensions
  • Output: (*, out_features)

§Example

use aprender::nn::{Module, Linear};
use aprender::autograd::Tensor;

let layer = Linear::new(20, 30);  // 20 inputs, 30 outputs
let x = Tensor::randn(&[128, 20]);  // batch of 128
let output = layer.forward(&x);     // [128, 30]

assert_eq!(output.shape(), &[128, 30]);

Implementations§

Source§

impl Linear

Source

pub fn new(in_features: usize, out_features: usize) -> Self

Create a new Linear layer with Xavier initialization.

§Arguments
  • in_features - Number of input features
  • out_features - Number of output features
§Example
let layer = Linear::new(784, 256);
Source

pub fn with_seed( in_features: usize, out_features: usize, seed: Option<u64>, ) -> Self

Create a Linear layer with a specific random seed.

Source

pub fn without_bias(in_features: usize, out_features: usize) -> Self

Create a Linear layer without bias.

Useful when followed by BatchNorm which has its own bias.

Source

pub fn without_bias_with_seed( in_features: usize, out_features: usize, seed: Option<u64>, ) -> Self

Create a Linear layer without bias with a specific random seed.

Source

pub fn in_features(&self) -> usize

Get the input feature dimension.

Source

pub fn out_features(&self) -> usize

Get the output feature dimension.

Source

pub fn has_bias(&self) -> bool

Check if this layer has a bias term.

Source

pub fn set_weight(&mut self, weight: Tensor)

Set weight tensor from external data.

Used for loading pre-trained weights from SafeTensors or other formats. Automatically computes and caches the transposed weight for fast forward.

Source

pub fn set_bias(&mut self, bias: Tensor)

Set bias tensor from external data.

Used for loading pre-trained weights.

Source

pub fn placeholder(in_features: usize, out_features: usize) -> Self

Create a placeholder Linear layer with minimal memory allocation.

Used for lazy initialization when loading pre-trained weights. The placeholder uses 1-element tensors instead of full matrices, reducing memory from O(in*out) to O(1).

IMPORTANT: This layer will NOT work for inference until set_weight() is called with real weights.

Source

pub fn weight(&self) -> &Tensor

Get reference to weight tensor.

Source

pub fn bias(&self) -> Option<&Tensor>

Get reference to bias tensor if present.

Source

pub fn is_ready(&self) -> bool

Check if this layer is ready for inference (weight_t is cached).

Returns false for placeholder layers that haven’t had set_weight() called. This is useful for verifying all layers are properly initialized before forward.

Trait Implementations§

Source§

impl Debug for Linear

Source§

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

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

impl Module for Linear

Source§

fn forward(&self, input: &Tensor) -> Tensor

Perform forward computation. Read more
Source§

fn parameters(&self) -> Vec<&Tensor>

Get references to all learnable parameters. Read more
Source§

fn parameters_mut(&mut self) -> Vec<&mut Tensor>

Get mutable references to all learnable parameters. Read more
Source§

fn refresh_caches(&mut self)

Refresh any cached computations after parameters have been modified. Read more
Source§

fn train(&mut self)

Set the module to training mode. Read more
Source§

fn eval(&mut self)

Set the module to evaluation mode. Read more
Source§

fn training(&self) -> bool

Check if the module is in training mode.
Source§

fn zero_grad(&mut self)

Zero out gradients for all parameters. Read more
Source§

fn num_parameters(&self) -> usize

Get the number of learnable parameters.

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, 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