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<T> AutodiffModule for Ignored<T>

where T: Sync + Send + Debug + Clone,

fn valid(&self) -> Self

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

fn from_inner(module: Self) -> 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<T> Module for Ignored<T>

where T: Sync + Send + Debug + Clone,

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

Visit each tensor parameter in the module with a visitor.

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

Map each tensor parameter in the module with a mapper.

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

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

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

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

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

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

fn devices(&self) -> Devices

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 freeze_group(self, group: ParamGroup) -> Self

Set require_grad to false for every parameter in the given group, leaving the rest of the module untouched.

fn unfreeze_group(self, group: ParamGroup) -> Self

Set require_grad to true for every parameter in the given group, leaving the rest of the module untouched.

fn train(self) -> Self

where Self: AutodiffModule,

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 quantize_weights(self, quantizer: &mut Quantizer) -> Self

Quantize the weights of the module.

fn quantize_weights_group( self, quantizer: &mut Quantizer, group: ParamGroup, ) -> Self

Quantize the weights of the given parameter group.

fn apply_lora(self, config: LoraConfig) -> Self

where Self: Sized,

Attach LoRA adapters to the module’s 2-D weights, freezing the base weights.

fn apply_qlora(self, config: LoraConfig, quantizer: Quantizer) -> Self

where Self: Sized,

Apply QLoRA to the module: quantize the (frozen) base weights and attach trainable LoRA adapters to 2-D weights.

fn into_record(self) -> ModuleRecord

where Self: Sized,

Collect this module’s parameters into a ModuleRecord.

fn try_load_record(self, record: ModuleRecord) -> Result<Self, RecordError>

where Self: Sized,

Apply a ModuleRecord to this module, returning the loaded module.

fn load_record(self, record: ModuleRecord) -> Self

where Self: Sized,

Apply a ModuleRecord to this module, consuming and returning it.

fn save_file<P: AsRef<Path>>(self, path: P) -> Result<(), RecordError>

where Self: Sized,

Available on crate feature std only.

Save this module’s parameters to a burnpack file on disk.

fn load_file<P: AsRef<Path>>(self, path: P) -> Self

where Self: Sized,

Available on crate feature std only.

Load this module’s parameters from a burnpack file on disk, returning the loaded module.

fn try_load_file<P: AsRef<Path>>(self, path: P) -> Result<Self, RecordError>

where Self: Sized,

Available on crate feature std only.

Fallible variant of load_file.

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.