Skip to main content

Ignored

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).

Expand description

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> Clone for Ignored<T>
where T: Clone,

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

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

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

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

Formats the value using the given formatter. Read more

impl<T> Deref for Ignored<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Ignored<T> as Deref>::Target

Dereferences the value.

impl<T> Display for Ignored<T>
where T: Sync + Send + Debug + Clone,

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

Formats the value using the given formatter. Read more

impl<T> Module for Ignored<T>
where T: Sync + Send + Debug + Clone,

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

Visit each parameter and module-owned control value with a visitor.

fn map<M>(self, _mapper: &mut M) -> Ignored<T>
where M: ModuleMapper,

Map each parameter and module-owned control value with a mapper.

fn to_device(self, _: &Device) -> Ignored<T>

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

fn fork(self, _: &Device) -> Ignored<T>

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

fn collect_devices(&self, devices: Vec<Device>) -> Vec<Device>

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

fn materialize(self) -> Ignored<T>

Fold parameter reparameterizations into their effective values and remove them. Read more

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

Returns a validation snapshot without autodiff or active training flags. Read more

fn train(self) -> Ignored<T>

Enables autodiff and restores configured training state throughout the module. Read more

fn devices(&self) -> Vec<Device>

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

fn set_require_grad(self, require_grad: bool) -> Self

Set whether every floating-point tensor parameter in the module tree requires gradients. Read more

fn set_require_grad_group(self, group: ParamGroup, require_grad: bool) -> Self

Set whether matched floating-point tensor parameters require gradients. Read more

fn no_grad(self) -> Self

Disable gradients for every floating-point tensor parameter in the module tree. Read more

fn freeze(self) -> Self

Freeze the whole module tree. Read more

fn unfreeze(self) -> Self

Unfreeze the whole module tree. Read more

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

Freeze every module-owned value in the given group, leaving the rest of the module untouched. Read more

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

Unfreeze every module-owned value in the given group, leaving the rest of the module untouched. Read more

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules, without initializing the ones not initialized yet.

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_reparameterization<R>(self, reparameterizer: R) -> Self
where Self: Sized, R: Reparameterizer,

Attach reparameterizations using the given Reparameterizer. Read more

fn apply_lora(self, lora: Lora) -> Self
where Self: Sized,

Attach LoRA adapters to the module’s 2-D weights, freezing all base tensor parameters. Read more

fn apply_qlora(self, qlora: QLora) -> Self
where Self: Sized,

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

fn into_record(self) -> ModuleRecord
where Self: Sized,

Collect this module’s tensor parameters into a ModuleRecord. Read more

fn into_record_group(self, group: ParamGroup) -> ModuleRecord
where Self: Sized,

Collect the tensor parameters group names into a ModuleRecord. Read more

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

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

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

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

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

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

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

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

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

Fallible variant of load_file. Read more

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. Read more

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

Custom display settings for the module. Read more

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

Custom attributes for the module. Read more

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. Read more

fn num_params(&self) -> usize

Gets the number of the parameters of the module.

Auto Trait Implementations§

impl<T> Freeze for Ignored<T>
where T: Freeze,

impl<T> RefUnwindSafe for Ignored<T>
where T: RefUnwindSafe,

impl<T> Send for Ignored<T>
where T: Send,

impl<T> Sync for Ignored<T>
where T: Sync,

impl<T> Unpin for Ignored<T>
where T: Unpin,

impl<T> UnsafeUnpin for Ignored<T>
where T: UnsafeUnpin,

impl<T> UnwindSafe for Ignored<T>
where T: UnwindSafe,

Blanket Implementations§

impl<T, A, P> Access<T> for P
where A: Access<T> + ?Sized, P: Deref<Target = A>,

type Guard = <A as Access<T>>::Guard

A guard object containing the value and keeping it alive. Read more

fn load(&self) -> <P as Access<T>>::Guard

The loading method. Read more

impl<T> Adaptor<()> for T

fn adapt(&self)

Adapt the type to be passed to a metric.

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

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

impl<K, Q> Comparable<Q> for K
where K: Borrow<Q> + ?Sized, Q: Ord + ?Sized,

fn compare(&self, key: &Q) -> Ordering

Compare self to key and return their ordering.

impl<T, A> DynAccess<T> for A
where A: Access<T>, <A as Access<T>>::Guard: 'static,

fn load(&self) -> DynGuard<T>

The equivalent of [Access::load].

impl<K, Q> Equivalent<Q> for K
where K: Borrow<Q> + ?Sized, Q: Eq + ?Sized,

fn equivalent(&self, key: &Q) -> bool

Compare self to key and return true if they are equal.

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> Formattable for T
where T: Deref, <T as Deref>::Target: Formattable,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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

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

impl<T> Parsable for T
where T: Deref, <T as Deref>::Target: Parsable,

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToCompactString for T
where T: Display,

fn try_to_compact_string(&self) -> Result<CompactString, ToCompactStringError>

Fallible version of [ToCompactString::to_compact_string()] Read more

fn to_compact_string(&self) -> CompactString

Converts the given value to a [CompactString]. Read more

impl<T> ToLine for T
where T: Display,

fn to_line(&self) -> Line<'_>

Converts the value to a [Line].

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> ToSpan for T
where T: Display,

fn to_span(&self) -> Span<'_>

Converts the value to a [Span].

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> ToText for T
where T: Display,

fn to_text(&self) -> Text<'_>

Converts the value to a [Text].

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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