### Copyright 2023 [Dawn Of Eve]

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#     http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from typing import Dict, Any, Optional
from dataclasses import dataclass

from .sgd import SGDConfig, SGD

__all__ = ['MomentumConfig', 'Momentum']

@dataclass
class MomentumConfig(SGDConfig):
  lr : float = 1E-3
  momentum : float = 0.9
  dampening : float = 0.05


class Momentum(SGD):
  
  def __init__(self, params, config : MomentumConfig = MomentumConfig()):
    if not 1 >= config.momentum > 0:
      raise ValueError(f"Invalid value for momentum in config: {config.momentum} ", 
                       "Value must not be 0")
      
    if not 1 >= config.dampening >= 0:
      raise ValueError(f"Invalid value for dampening in config: {config.dampening} ", 
                       "Value must not be less than 0")
    
    super().__init__(params, config)
    self.config = config