gctl_ai/lib/dnn/olayer_rmse.h
2024-09-10 20:15:33 +08:00

59 lines
2.7 KiB
C++

/********************************************************
* ██████╗ ██████╗████████╗██╗
* ██╔════╝ ██╔════╝╚══██╔══╝██║
* ██║ ███╗██║ ██║ ██║
* ██║ ██║██║ ██║ ██║
* ╚██████╔╝╚██████╗ ██║ ███████╗
* ╚═════╝ ╚═════╝ ╚═╝ ╚══════╝
* Geophysical Computational Tools & Library (GCTL)
*
* Copyright (c) 2022 Yi Zhang (yizhang-geo@zju.edu.cn)
*
* GCTL is distributed under a dual licensing scheme. You can redistribute
* it and/or modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation, either version 2
* of the License, or (at your option) any later version. You should have
* received a copy of the GNU Lesser General Public License along with this
* program. If not, see <http://www.gnu.org/licenses/>.
*
* If the terms and conditions of the LGPL v.2. would prevent you from using
* the GCTL, please consider the option to obtain a commercial license for a
* fee. These licenses are offered by the GCTL's original author. As a rule,
* licenses are provided "as-is", unlimited in time for a one time fee. Please
* send corresponding requests to: yizhang-geo@zju.edu.cn. Please do not forget
* to include some description of your company and the realm of its activities.
* Also add information on how to contact you by electronic and paper mail.
******************************************************/
#ifndef _GCTL_DNN_OLAYER_RMSE_H
#define _GCTL_DNN_OLAYER_RMSE_H
#include "olayer.h"
namespace gctl
{
class rmse : public dnn_olayer
{
public:
rmse();
virtual ~rmse();
// A combination of the forward stage and the back-propagation stage for the output layer
// The computed derivative of the input should be stored in this layer, and can be retrieved by
// the backward_propagation_data() function
void evaluation(const matrix<double> &prev_layer_data, const matrix<double> &target);
// Return the loss function value after the evaluation
// This function can be assumed to be called after evaluate(), so that it can make use of the
// intermediate result to save some computation
double loss_value() const;
// Return the output layer name. It is used to export the NN model.
std::string get_output_name() const;
// Return the output layer type. It is used to export the NN model.
olayer_type_e get_output_type() const;
};
}
#endif // _GCTL_DNN_OLAYER_RMSE_H