Skip to main content

Sequential

Struct Sequential 

Source
pub struct Sequential<T: Scalar, B: ComputeBackend + Default = MoiraiBackend> { /* private fields */ }
Expand description

A sequential container that chains modules.

forward passes the output of each module as the input to the next.

§Example

ⓘ
let mut seq = Sequential::<f64>::new();
seq.add(Linear::new(64, 128, true));
seq.add(ReLU);
seq.add(Linear::new(128, 10, true));
let output = seq.forward(&input).expect("valid Sequential input");

Implementations§

Source§

impl<T: Scalar, B: ComputeBackend + Default> Sequential<T, B>

Source

pub fn new() -> Self

Create an empty Sequential.

Source

pub fn add<M: Module<T, B> + 'static>(&mut self, module: M) -> &mut Self

Append a module to the end of the sequence.

Returns &mut Self to enable method chaining.

Source

pub fn len(&self) -> usize

Return the number of modules in this sequential.

Source

pub fn is_empty(&self) -> bool

Return true if this sequential has no modules.

Trait Implementations§

Source§

impl<T: Scalar, B: ComputeBackend + Default> Default for Sequential<T, B>

Source§

fn default() -> Self

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

impl<T: Scalar, B: ComputeBackend + Default> Module<T, B> for Sequential<T, B>

Source§

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

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

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

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

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

Evaluate this module. Read more
Source§

fn train(&mut self, mode: bool)

Set the training mode of the module and its sub-modules.
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 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 eval(&mut self)

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

Auto Trait Implementations§

§

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

§

impl<T, B = MoiraiBackend> !Send for Sequential<T, B>

§

impl<T, B = MoiraiBackend> !Sync for Sequential<T, B>

§

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

§

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

§

impl<T, B> Freeze for Sequential<T, B>
where Vec<Box<dyn Module<T, B>>>: Freeze,

§

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

§

impl<T, B> Unpin for Sequential<T, B>
where Vec<Box<dyn Module<T, B>>>: Unpin,

§

impl<T, B> UnsafeUnpin for Sequential<T, B>
where Vec<Box<dyn Module<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> 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, 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