GradientDescent

Struct GradientDescent 

Source
pub struct GradientDescent<Input, Output, M: OptimizableModel<Input, Output>> {
    pub cost_history: Vec<f64>,
    /* private fields */
}
Expand description

A standard gradient descent optimizer.

Gradient descent is an optim algorithm that iteratively adjusts parameters to minimize a cost function by moving in the direction of the steepest decrease in the cost function.

§Fields

  • learning_rate - The step size for each iteration of gradient descent
  • epochs - The number of complete passes through the training dataset
  • cost_history - Records the cost value after each parameter update

Fields§

§cost_history: Vec<f64>

Implementations§

Source§

impl<Input, Output, M: OptimizableModel<Input, Output>> GradientDescent<Input, Output, M>

Source

pub fn new(learning_rate: f64, epochs: usize) -> Self

Creates a new GradientDescent optimizer.

§Arguments
  • learning_rate - The step size for each parameter update
  • epochs - The number of complete passes through the training dataset
§Returns

A new GradientDescent instance

Trait Implementations§

Source§

impl<M: OptimizableModel<Matrix, Vector>> Optimizer<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>, M> for GradientDescent<Matrix, Vector, M>

Source§

fn fit( &mut self, model: &mut M, x: &Matrix, y: &Vector, ) -> Result<(), ModelError>

Fits the model to the training data using gradient descent algorithm.

This method updates the model parameters by computing gradients and adjusting the parameters in the direction that minimizes the cost function.

§Arguments
  • model - The machine learning model to optimize
  • x - The input training data
  • y - The expected output values
§Returns
  • Ok(()) if optim completes successfully
  • Err(ModelError) if an error occurs during optim

Auto Trait Implementations§

§

impl<Input, Output, M> Freeze for GradientDescent<Input, Output, M>

§

impl<Input, Output, M> RefUnwindSafe for GradientDescent<Input, Output, M>
where Input: RefUnwindSafe, Output: RefUnwindSafe, M: RefUnwindSafe,

§

impl<Input, Output, M> Send for GradientDescent<Input, Output, M>
where Input: Send, Output: Send,

§

impl<Input, Output, M> Sync for GradientDescent<Input, Output, M>
where Input: Sync, Output: Sync,

§

impl<Input, Output, M> Unpin for GradientDescent<Input, Output, M>
where Input: Unpin, Output: Unpin, M: Unpin,

§

impl<Input, Output, M> UnwindSafe for GradientDescent<Input, Output, M>
where Input: UnwindSafe, Output: UnwindSafe, M: UnwindSafe,

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> IntoEither for T

Source§

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
Source§

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
Source§

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

Source§

fn vzip(self) -> V