Skip to main content

NNOptimizerRmsProp

Struct NNOptimizerRmsProp 

Source
pub struct NNOptimizerRmsProp { /* private fields */ }
Expand description

Wraps MPSNNOptimizerRMSProp.

Implementations§

Source§

impl NNOptimizerRmsProp

Source

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

Returns the retained Objective-C pointer backing this wrapper.

Source§

impl NNOptimizerRmsProp

Source

pub fn learning_rate(&self) -> f32

Wraps the corresponding Metal Performance Shaders method.

Source

pub fn set_learning_rate(&self, value: f32)

Wraps the corresponding Metal Performance Shaders method.

Source

pub fn gradient_rescale(&self) -> f32

Wraps the corresponding Metal Performance Shaders method.

Source

pub fn apply_gradient_clipping(&self) -> bool

Wraps the corresponding Metal Performance Shaders method.

Source

pub fn set_apply_gradient_clipping(&self, value: bool)

Wraps the corresponding Metal Performance Shaders method.

Source

pub fn gradient_clip_max(&self) -> f32

Wraps the corresponding Metal Performance Shaders method.

Source

pub fn gradient_clip_min(&self) -> f32

Wraps the corresponding Metal Performance Shaders method.

Source

pub fn regularization_scale(&self) -> f32

Wraps the corresponding Metal Performance Shaders method.

Source

pub fn regularization_type(&self) -> usize

Wraps the corresponding Metal Performance Shaders method.

Source§

impl NNOptimizerRmsProp

Source

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

Wraps a constructor on MPSNNOptimizerRMSProp.

Source

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

Wraps a constructor on MPSNNOptimizerRMSProp.

Source

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

Wraps the corresponding MPSNNOptimizerRMSProp conversion helper.

Source

pub fn decay(&self) -> f64

Wraps the corresponding MPSNNOptimizerRMSProp method.

Source

pub fn epsilon(&self) -> f32

Wraps the corresponding MPSNNOptimizerRMSProp method.

Source

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

Wraps the corresponding MPSNNOptimizerRMSProp encode entry point.

Source

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

Wraps the corresponding MPSNNOptimizerRMSProp encode entry point.

Trait Implementations§

Source§

impl Drop for NNOptimizerRmsProp

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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

impl Send for NNOptimizerRmsProp

Source§

impl Sync for NNOptimizerRmsProp

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.