Skip to main content

Linear

Struct Linear 

Source
pub struct Linear<T: Scalar, B: BackendOps<T> + Default = MoiraiBackend> {
    pub weight: Var<T, B>,
    pub bias: Option<Var<T, B>>,
}
Expand description

Fully-connected linear layer.

Fields§

§weight: Var<T, B>

Weight matrix: [out_features × in_features].

§bias: Option<Var<T, B>>

Bias vector: [out_features].

Implementations§

Source§

impl<T, B> Linear<T, B>

Construction needs more of T and B than holding a layer does – the weights are drawn, so the scalar must be sampleable and the backend must be able to sample it. The bounds sit here rather than on the type so Linear<T, B> stays nameable for any scalar.

Source

pub fn new( in_features: usize, out_features: usize, bias: bool, ) -> Result<Self, InitializationError<B::Error>>

Create a Linear layer with given input/output features.

Weights are drawn Kaiming-uniform over in_features from a fixed seed, so a layer built the same way twice is the same layer; use Linear::with_seed to choose the draw. Biases are zero.

§Errors

Returns InitializationError when in_features is zero, or when the backend’s draw fails.

Source

pub fn with_seed( in_features: usize, out_features: usize, bias: bool, seed: u64, ) -> Result<Self, InitializationError<B::Error>>

Create a Linear layer whose weights are drawn from seed.

§Errors

As Linear::new.

Trait Implementations§

Source§

impl<T: Clone + Scalar, B: Clone + BackendOps<T> + Default> Clone for Linear<T, B>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Scalar + RealScalar, B: BackendOps<T> + Default> Module<T, B> for Linear<T, B>

Source§

fn parameters(&self) -> Vec<Var<T, B>>

Collect all trainable parameters (including from sub-modules).
Source§

fn forward(&self, input: &Var<T, B>) -> Result<Var<T, B>, ModuleError<B::Error>>

Evaluate this module. Read more
Source§

fn load_parameters(&mut self, params: &[Var<T, B>])

Write optimizer-updated parameter values back into this module’s own fields, consuming params in the same order parameters() enumerates them (i.e. params.len() == parameters().len()). Read more
Source§

fn named_parameters(&self) -> Vec<Parameter<T, B>>

Collect trainable parameters with stable hierarchical names. Read more
Source§

fn load_named_parameters( &mut self, parameters: &[Parameter<T, B>], ) -> Result<(), ParameterLoadError>

Load optimizer-updated named parameters after validating the complete stable path inventory. Read more
Source§

fn zero_grad(&self) -> Result<(), B::Error>

Zero all parameter gradients.
Source§

fn train(&mut self, _mode: bool)

Set the training mode of the module and its sub-modules.
Source§

fn eval(&mut self)

Set the module and its sub-modules to evaluation mode.

Auto Trait Implementations§

§

impl<T, B = MoiraiBackend> !RefUnwindSafe for Linear<T, B>

§

impl<T, B = MoiraiBackend> !UnwindSafe for Linear<T, B>

§

impl<T, B> Forget for Linear<T, B>

§

impl<T, B> Freeze for Linear<T, B>
where Var<T, B>: Freeze, Option<Var<T, B>>: Freeze,

§

impl<T, B> Move for Linear<T, B>

§

impl<T, B> Send for Linear<T, B>
where Var<T, B>: Send, Option<Var<T, B>>: Send,

§

impl<T, B> Sync for Linear<T, B>
where Var<T, B>: Sync, Option<Var<T, B>>: Sync,

§

impl<T, B> Unpin for Linear<T, B>
where Var<T, B>: Unpin, Option<Var<T, B>>: Unpin,

§

impl<T, B> UnsafeUnpin for Linear<T, B>
where Var<T, B>: UnsafeUnpin, Option<Var<T, B>>: UnsafeUnpin,

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, B, M> ModuleExt<T, B> for M
where T: Scalar, B: ComputeBackend + Default, M: Module<T, B>,

Source§

fn append<Next>(self, next: Next) -> StaticSeq<M, Next>
where Next: Module<T, B>,

Append another module to the end of the sequence.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more