neural_network.optimizers.momentum_sgd
======================================

.. py:module:: neural_network.optimizers.momentum_sgd

.. autoapi-nested-parse::

   Momentum SGD Optimizer

   Implements SGD with momentum for neural network training using NumPy.
   Momentum helps accelerate gradients in the relevant direction and dampens oscillations.

   Reference: https://en.wikipedia.org/wiki/Stochastic_gradient_descent#Momentum
   Author: Adhithya Laxman Ravi Shankar Geetha
   Github: https://github.com/Adhithya-Laxman
   Date: 2025.10.22



Attributes
----------

.. autoapisummary::

   neural_network.optimizers.momentum_sgd.optimizer


Classes
-------

.. autoapisummary::

   neural_network.optimizers.momentum_sgd.MomentumSGD


Module Contents
---------------

.. py:class:: MomentumSGD(learning_rate: float = 0.01, momentum: float = 0.9)

   SGD with momentum optimizer.

   Updates parameters using momentum:
       velocity = momentum * velocity - learning_rate * gradient
       param = param + velocity


   .. py:method:: update(param_id: int, params: numpy.ndarray, gradients: numpy.ndarray) -> numpy.ndarray

      Update parameters using momentum.

      Args:
          param_id (int): Unique identifier for parameter group.
          params (np.ndarray): Current parameters.
          gradients (np.ndarray): Gradients of parameters.

      Returns:
          np.ndarray: Updated parameters.

      >>> optimizer = MomentumSGD(learning_rate=0.1, momentum=0.9)
      >>> params = np.array([1.0, 2.0])
      >>> grads = np.array([0.1, 0.2])
      >>> updated = optimizer.update(0, params, grads)
      >>> updated.shape
      (2,)



   .. py:attribute:: learning_rate
      :value: 0.01



   .. py:attribute:: momentum
      :value: 0.9



   .. py:attribute:: velocity
      :type:  dict[int, numpy.ndarray]


.. py:data:: optimizer