summaryrefslogtreecommitdiff
path: root/compiler/circle-eval-diff/include/CircleEvalDiff.h
blob: 7894480ac42a35cb5850f731a40e403af4d8e48f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/*
 * Copyright (c) 2022 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * 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.
 */

#ifndef __CIRCLE_EVAL_DIFF_H__
#define __CIRCLE_EVAL_DIFF_H__

#include <luci/IR/Module.h>
#include <luci_interpreter/Interpreter.h>

#include "InputDataLoader.h"
#include "MetricPrinter.h"

#include <string>
#include <memory>
#include <vector>

namespace circle_eval_diff
{

// Forward declaration
class ModuleEvalDiff;

enum class Metric
{
  Undefined, // For debugging
  MAE,       // Mean Absolute Error
  MAPE,      // Mean Percentage Absolute Error
  MPEIR,     // Mean Peak Error to Interval Ratio
  MTOP1,     // Mean Top-1 Match Ratio
  MTOP5,     // Mean Top-5 Match Ratio
  MSE,       // Mean Squared Error
};

class CircleEvalDiff final
{
public:
  struct Context
  {
    std::string first_model_path;
    std::string second_model_path;
    std::string first_input_data_path;
    std::string second_input_data_path;
    std::vector<Metric> metric;
    InputFormat input_format = InputFormat::Undefined;
    std::string output_prefix;
  };

public:
  CircleEvalDiff(std::unique_ptr<Context> &&ctx);

  ~CircleEvalDiff();

  void init();

  // Evaluate two circle models for the given input data and compare the results
  void evalDiff(void) const;

private:
  std::unique_ptr<Context> _ctx;
  std::unique_ptr<luci::Module> _first_module;
  std::unique_ptr<luci::Module> _second_module;
  std::vector<std::unique_ptr<MetricPrinter>> _metrics;
};

} // namespace circle_eval_diff

#endif // __CIRCLE_EVAL_DIFF_H__