Struct NNOptimizerAdam 

pub struct NNOptimizerAdam { /* private fields */ }

Wraps MPSNNOptimizerAdam.

Implementations

impl NNOptimizerAdam

pub const fn as_ptr(&self) -> *mut c_void

Returns the retained Objective-C pointer backing this wrapper.

impl NNOptimizerAdam

pub fn learning_rate(&self) -> f32

Wraps the corresponding Metal Performance Shaders method.

pub fn set_learning_rate(&self, value: f32)

Wraps the corresponding Metal Performance Shaders method.

pub fn gradient_rescale(&self) -> f32

Wraps the corresponding Metal Performance Shaders method.

pub fn apply_gradient_clipping(&self) -> bool

Wraps the corresponding Metal Performance Shaders method.

pub fn set_apply_gradient_clipping(&self, value: bool)

Wraps the corresponding Metal Performance Shaders method.

pub fn gradient_clip_max(&self) -> f32

Wraps the corresponding Metal Performance Shaders method.

pub fn gradient_clip_min(&self) -> f32

Wraps the corresponding Metal Performance Shaders method.

pub fn regularization_scale(&self) -> f32

Wraps the corresponding Metal Performance Shaders method.

pub fn regularization_type(&self) -> usize

Wraps the corresponding Metal Performance Shaders method.

impl NNOptimizerAdam

pub fn new(device: &MetalDevice, learning_rate: f32) -> Option<Self>

Wraps a constructor on MPSNNOptimizerAdam.

pub fn new_with_options( device: &MetalDevice, beta1: f64, beta2: f64, epsilon: f32, time_step: usize, optimizer_descriptor: &NNOptimizerDescriptor, ) -> Option<Self>

Wraps a constructor on MPSNNOptimizerAdam.

pub fn as_optimizer(&self) -> Option<NNOptimizer>

Wraps the corresponding MPSNNOptimizerAdam conversion helper.

pub fn beta1(&self) -> f64

Wraps the corresponding MPSNNOptimizerAdam method.

pub fn beta2(&self) -> f64

Wraps the corresponding MPSNNOptimizerAdam method.

pub fn epsilon(&self) -> f32

Wraps the corresponding MPSNNOptimizerAdam method.

pub fn time_step(&self) -> usize

Wraps the corresponding MPSNNOptimizerAdam method.

pub fn set_time_step(&self, value: usize)

Wraps the corresponding MPSNNOptimizerAdam setter.

pub fn encode_vector( &self, command_buffer: &CommandBuffer, input_gradient_vector: &Vector, input_values_vector: &Vector, input_momentum_vector: &Vector, input_velocity_vector: &Vector, result_values_vector: &Vector, )

Wraps the corresponding MPSNNOptimizerAdam encode entry point.

pub fn encode_matrix( &self, command_buffer: &CommandBuffer, input_gradient_matrix: &Matrix, input_values_matrix: &Matrix, input_momentum_matrix: &Matrix, input_velocity_matrix: &Matrix, result_values_matrix: &Matrix, )

Wraps the corresponding MPSNNOptimizerAdam encode entry point.

pub fn encode_amsgrad_vector( &self, command_buffer: &CommandBuffer, input_gradient_vector: &Vector, input_values_vector: &Vector, input_momentum_vector: &Vector, input_velocity_vector: &Vector, maximum_velocity_vector: Option<&Vector>, result_values_vector: &Vector, )

Wraps the corresponding MPSNNOptimizerAdam encode entry point.

pub fn encode_amsgrad_matrix( &self, command_buffer: &CommandBuffer, input_gradient_matrix: &Matrix, input_values_matrix: &Matrix, input_momentum_matrix: &Matrix, input_velocity_matrix: &Matrix, maximum_velocity_matrix: Option<&Matrix>, result_values_matrix: &Matrix, )

Wraps the corresponding MPSNNOptimizerAdam encode entry point.

Trait Implementations

impl Drop for NNOptimizerAdam

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for NNOptimizerAdam

impl Sync for NNOptimizerAdam