Struct Ignored 

pub struct Ignored<T>(pub T);

👎Deprecated since 0.21.0:

Ignored<T> is deprecated. Use #[module(skip)] for non-persistent fields (same behavior).

Container to satisfy the Module trait for types that are not modules.

Tuple Fields

0: T

👎Deprecated since 0.21.0:

Ignored<T> is deprecated. Use #[module(skip)] for non-persistent fields (same behavior).

Trait Implementations

impl<B, T> AutodiffModule<B> for Ignored<T>

where B: AutodiffBackend, T: Sync + Send + Debug + Clone,

type InnerModule = Ignored<T>

Inner module without auto-differentiation.

fn valid(&self) -> Self::InnerModule

Returns the same module, but on the inner backend without auto-differentiation.

fn from_inner(module: Self::InnerModule) -> Self

Wraps an inner module back into an auto-diff module.

impl<T: Clone> Clone for Ignored<T>

fn clone(&self) -> Ignored<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Ignored<T>

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

Formats the value using the given formatter.

impl<T> Deref for Ignored<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> Display for Ignored<T>

where T: Sync + Send + Debug + Clone,

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

Formats the value using the given formatter.

impl<B, T> Module<B> for Ignored<T>

where B: Backend, T: Sync + Send + Debug + Clone,

type Record = EmptyRecord

Type to save and load the module.

fn visit<V: ModuleVisitor<B>>(&self, _visitor: &mut V)

Visit each tensor parameter in the module with a visitor.

fn map<M: ModuleMapper<B>>(self, _mapper: &mut M) -> Self

Map each tensor parameter in the module with a mapper.

fn load_record(self, _record: Self::Record) -> Self

Load the module state from a record.

fn into_record(self) -> Self::Record

Convert the module into a record containing the state.

fn to_device(self, _: &Device<B>) -> Self

Move the module and all of its sub-modules to the given device.

fn fork(self, _: &Device<B>) -> Self

Fork the module and all of its sub-modules to the given device.

fn collect_devices(&self, devices: Devices<B>) -> Devices<B>

Return all the devices found in the underneath module tree added to the given vector without duplicates.

fn devices(&self) -> Devices<B>

Return all the devices found in the underneath module tree without duplicates.

fn no_grad(self) -> Self

Each tensor in the module tree will not require grad.

fn train<AB>(self) -> <Self as HasAutodiffModule<AB>>::TrainModule

where AB: AutodiffBackend<InnerBackend = B>, Self: HasAutodiffModule<AB>,

Move the module and all of its sub-modules to the autodiff backend.

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules.

fn save_file<FR, PB>( self, file_path: PB, recorder: &FR, ) -> Result<(), RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Available on crate feature std only.

Save the module to a file using the provided file recorder.

fn load_file<FR, PB>( self, file_path: PB, recorder: &FR, device: &B::Device, ) -> Result<Self, RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Available on crate feature std only.

Load the module from a file using the provided file recorder.

fn quantize_weights(self, quantizer: &mut Quantizer) -> Self

Quantize the weights of the module.

impl<T> ModuleDisplay for Ignored<T>

where T: Sync + Send + Debug + Clone,

fn format(&self, passed_settings: DisplaySettings) -> String

Formats the module with provided display settings.

fn custom_settings(&self) -> Option<DisplaySettings>

Custom display settings for the module.

fn custom_content(&self, _content: Content) -> Option<Content>

Custom attributes for the module.

impl<T> ModuleDisplayDefault for Ignored<T>

where T: Sync + Send + Debug + Clone,

fn content(&self, content: Content) -> Option<Content>

Attributes of the module used for display purposes.

fn num_params(&self) -> usize

Gets the number of the parameters of the module.