Struct Constrained 

pub struct Constrained<M, Man> { /* private fields */ }

Implementations

impl<M, Man> Constrained<M, Man>

pub fn new(module: M) -> Self

pub fn inner(&self) -> &M

Get a reference to the inner module

pub fn inner_mut(&mut self) -> &mut M

Get a mutable reference to the inner module

pub fn project_tensor<B, const D: usize>( &self, point: Tensor<B, D>, vector: Tensor<B, D>, ) -> Tensor<B, D>

where B: Backend, M: Module<B>, Man: Manifold<B> + Clone + Debug + Send,

Apply manifold projection to a tensor - requires explicit Backend type

pub fn retract_tensor<B, const D: usize>( &self, point: Tensor<B, D>, direction: Tensor<B, D>, ) -> Tensor<B, D>

where B: Backend, M: Module<B>, Man: Manifold<B> + Clone + Debug + Send,

Apply manifold retraction to a tensor - requires explicit Backend type

pub fn euclidean_to_riemannian<B, const D: usize>( &self, point: Tensor<B, D>, grad: Tensor<B, D>, ) -> Tensor<B, D>

where B: Backend, M: Module<B>, Man: Manifold<B> + Clone + Debug + Send,

Convert Euclidean gradient to Riemannian gradient - requires explicit Backend type

pub fn project_to_manifold<B, const D: usize>( &self, point: Tensor<B, D>, ) -> Tensor<B, D>

where B: Backend, M: Module<B>, Man: Manifold<B> + Clone + Debug + Send,

Project point onto manifold - requires explicit Backend type

pub fn manifold_name<B>(&self) -> &'static str

where B: Backend, Man: Manifold<B>,

Get the manifold name

Trait Implementations

impl<B, M, Man> AutodiffModule<B> for Constrained<M, Man>

where M: AutodiffModule<B>, B: AutodiffBackend, Man: Clone + Debug + Send,

type InnerModule = <M as AutodiffModule<B>>::InnerModule

Inner module without auto-differentiation.

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

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

impl<M: Clone, Man: Clone> Clone for Constrained<M, Man>

fn clone(&self) -> Constrained<M, Man>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B, M, Man> ConstrainedModule<B> for Constrained<M, Man>

where M: Module<B>, B: Backend, Man: Manifold<B> + Clone + Debug + Send,

Blanket implementation for Constrained wrapper

fn apply_manifold_constraints(self) -> Self

Apply manifold constraints to all parameters in the module

fn get_manifold_info(&self) -> HashMap<String, String>

Get information about the manifold constraints

fn has_manifold_constraints(&self) -> bool

Check if this module has manifold constraints

impl<M: Debug, Man: Debug> Debug for Constrained<M, Man>

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

Formats the value using the given formatter.

impl<B, M, Man> ManifoldOptimizable<B> for Constrained<M, Man>

where M: Module<B>, B: Backend, Man: Manifold<B> + Clone + Debug + Send,

fn apply_manifold_constraints(self) -> Self

Apply manifold constraints to the module

fn get_manifold_info(&self) -> HashMap<String, String>

Get information about manifold constraints

impl<B, M, Man> Module<B> for Constrained<M, Man>

where M: Module<B>, B: Backend, Man: Clone + Debug + Send,

type Record = <M as Module<B>>::Record

Type to save and load the module.

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 fork(self, device: &B::Device) -> Self

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

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

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

fn visit<Visitor: ModuleVisitor<B>>(&self, visitor: &mut Visitor)

Visit each tensor parameter in the module with a visitor.

fn map<Mapper: ModuleMapper<B>>(self, mapper: &mut Mapper) -> 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 devices(&self) -> Vec<<B as Backend>::Device>

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 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>,

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

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

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

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<M, Man> ModuleDisplay for Constrained<M, Man>

where M: ModuleDisplay, Man: Clone + Debug + Send,

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<M, Man> ModuleDisplayDefault for Constrained<M, Man>

where M: ModuleDisplayDefault, Man: Clone + Debug + Send,

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.