Imported Upstream version 1.25.0
[platform/core/ml/nnfw.git] / runtime / onert / core / include / ir / operation / Loss.h
1 /*
2  * Copyright (c) 2023 Samsung Electronics Co., Ltd. All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef __ONERT_IR_OPERATION_LOSS_H__
18 #define __ONERT_IR_OPERATION_LOSS_H__
19
20 #include "ir/Operation.h"
21
22 namespace onert
23 {
24 namespace ir
25 {
26 namespace operation
27 {
28
29 class Loss : public Operation
30 {
31 public:
32   enum Input
33   {
34     Y_PRED = 0,
35     Y_TRUE = 1
36     // TODO Add more inputs if necessary
37   };
38
39   // NOTE It is not yet determined how to get the information of the previous activation when
40   //      generating kernels of Loss operation for each backend. If it is determined to get it
41   //      from the object of this class, we have to consider whether to change this enum class.
42   enum class Type
43   {
44     MEAN_SQUARED_ERROR,
45     CATEGORICAL_CROSSENTROPY
46   };
47
48   struct Param
49   {
50     Type op_type;
51     // TODO Add more params if necessary
52     Param() : op_type(Type::MEAN_SQUARED_ERROR) {}
53   };
54
55 public:
56   Loss(const OperandIndexSequence &inputs, const OperandIndexSequence &outputs, const Param &param);
57
58 public:
59   void accept(OperationVisitor &v) const override;
60   std::string name() const override;
61   OpCode opcode() const final { return OpCode::Loss; }
62
63 public:
64   const Param &param() const { return _param; }
65
66 private:
67   Param _param;
68 };
69
70 } // namespace operation
71 } // namespace ir
72 } // namespace onert
73
74 #endif // __ONERT_IR_OPERATION_LOSS_H__