Struct Flag 

pub struct Flag(/* private fields */);

A boolean parameter value used for module-owned control state.

Param<Flag> gives the value an identity in the module tree, allowing parameter groups to select it by id or path just like other module-owned values. The field holding the flag gives it its meaning; for example, Dropout::training uses an enabled flag to permit stochastic behavior on an autodiff device.

Records

Flags are runtime configuration, not persisted model state. Module records omit their value, lifecycle state and ParamId; loading a record preserves the destination module’s flag exactly as configured. This mirrors tensor parameters, whose values and ids are recorded but whose require_grad configuration comes from the destination module.

Devices

Flags are host-side control state and do not reside on a compute device. Moving or forking a module preserves a flag unchanged, and flags do not contribute entries to Module::devices.

Implementations

impl Flag

pub const fn new(value: bool) -> Self

Create a flag with the given value.

pub const fn is_enabled(&self) -> bool

Whether the flag is enabled.

pub const fn with(self, value: bool) -> Self

Return the flag with the given value.

Trait Implementations

impl Clone for Flag

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Flag

impl Debug for Flag

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

Formats the value using the given formatter.

impl Display for Flag

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

Formats the value using the given formatter.

impl Eq for Flag

impl ParameterValue for Flag

impl PartialEq for Flag

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Flag