105 lines
3.1 KiB
C++
105 lines
3.1 KiB
C++
/**++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
*
|
|
* PANIC
|
|
* Portable Algorithms and Numerics In C++
|
|
*
|
|
* Scientific computing from scratch, with feeling.
|
|
*
|
|
* Copyright (c) 2026 Michelle Bausager
|
|
*
|
|
* This file is part of PANIC.
|
|
*
|
|
* PANIC is free software licensed under the GNU General Public License v3.0 or later.
|
|
* You may redistribute and/or modify it under the terms of the GPL.
|
|
*
|
|
* PANIC is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
|
|
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
* See the LICENSE file for the full license text.
|
|
*
|
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
|
*
|
|
*++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
*
|
|
* Project Name: PANIC
|
|
* Module Name: neural_network
|
|
* File Name: optimizer.hpp
|
|
* Revision: 0.1.0
|
|
* Date: 06-08-2026
|
|
* Author: Michelle Bausager
|
|
*
|
|
* Description:
|
|
* Defines the base optimizer struct used in neural network
|
|
*
|
|
*++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/
|
|
#pragma once
|
|
//---------------------------------------------------------------------------------------------------------------------------
|
|
// INCLUDE DESCRIPTION
|
|
//---------------------------------------------------------------------------------------------------------------------------
|
|
#include <config/types.hpp> // panic::uint_t, panic::int_t, and panic::real_t
|
|
#include <neural_network/layer/trainable_layer.hpp>
|
|
|
|
|
|
namespace panic{
|
|
namespace neural_network{
|
|
|
|
|
|
|
|
/**
|
|
* @brief Base optimizer for the rest of the neural network library to use
|
|
*
|
|
* This base optimizer should be used in neural networks
|
|
* This is done so it's easy to optimize the trainable layers in the model to loop over.
|
|
* The virtual means it should use derived object's version when called with a pointer.
|
|
* The =0 means the derivative object NEEDS to have these functions to work.
|
|
*
|
|
* The struct is used for PANIC neural_network library.
|
|
*/
|
|
struct optimizer{
|
|
|
|
panic::types::real_t current_learning_rate;
|
|
|
|
/**
|
|
* @brief Default de-constructor
|
|
*
|
|
*/
|
|
virtual ~optimizer() = default;
|
|
|
|
|
|
/**
|
|
* @brief Virtual update parameters function for derivative optimizers
|
|
*
|
|
* @param layer trainable layer to have their parameters updated
|
|
*
|
|
* @Note It's equal to 0 because it make the derivative
|
|
* object NEEDS to have these function to work.
|
|
*/
|
|
virtual bool update_params(trainable_layer& layer) = 0;
|
|
|
|
/**
|
|
* @brief Virtual function to update internal parameters before update_params()
|
|
*
|
|
*
|
|
*/
|
|
virtual bool pre_update_params(){
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @brief Virtual function to update internal parameters after update_params()
|
|
*
|
|
*
|
|
*/
|
|
virtual bool post_update_params(){
|
|
return true;
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace tensor
|
|
} // namespace panic
|
|
|
|
|
|
|