application.h 2.17 KB
Newer Older
Guolin Ke's avatar
Guolin Ke committed
1
2
3
4
5
6
7
#ifndef LIGHTGBM_APPLICATION_H_
#define LIGHTGBM_APPLICATION_H_

#include <LightGBM/meta.h>
#include <LightGBM/config.h>

#include <vector>
Guolin Ke's avatar
Guolin Ke committed
8
#include <memory>
Guolin Ke's avatar
Guolin Ke committed
9
10
11

namespace LightGBM {

Guolin Ke's avatar
Guolin Ke committed
12
class DatasetLoader;
Guolin Ke's avatar
Guolin Ke committed
13
14
15
16
17
18
class Dataset;
class Boosting;
class ObjectiveFunction;
class Metric;

/*!
Qiwei Ye's avatar
Qiwei Ye committed
19
* \brief The main entrance of LightGBM. this application has two tasks:
20
21
22
23
*        Train and Predict.
*        Train task will train a new model
*        Predict task will predicting the scores of test data using exsiting model,
*        and saving the score to disk.
Guolin Ke's avatar
Guolin Ke committed
24
25
26
27
28
29
30
31
32
33
34
35
36
*/
class Application {
public:
  Application(int argc, char** argv);

  /*! \brief Destructor */
  ~Application();

  /*! \brief To call this funciton  to run application*/
  inline void Run();

private:
  /*! 
Qiwei Ye's avatar
Qiwei Ye committed
37
  * \brief Global Sync by minimal, will return minimal T across nodes
Guolin Ke's avatar
Guolin Ke committed
38
  * \param local Local data
Qiwei Ye's avatar
Qiwei Ye committed
39
  * \return minimal values across nodes 
Guolin Ke's avatar
Guolin Ke committed
40
41
42
43
44
45
46
47
48
49
  */
  template<typename T>
  T GlobalSyncUpByMin(T& local);

  /*! \brief Load parametes from command line and config file*/
  void LoadParameters(int argc, char** argv);

  /*! \brief Load data, including training data and validation data*/
  void LoadData();

Qiwei Ye's avatar
Qiwei Ye committed
50
  /*! \brief Initialization before training*/
Guolin Ke's avatar
Guolin Ke committed
51
52
  void InitTrain();

Qiwei Ye's avatar
Qiwei Ye committed
53
  /*! \brief Main Training logic */
Guolin Ke's avatar
Guolin Ke committed
54
55
  void Train();

Qiwei Ye's avatar
Qiwei Ye committed
56
  /*! \brief Initializations before prediction */
Guolin Ke's avatar
Guolin Ke committed
57
58
  void InitPredict();

Qiwei Ye's avatar
Qiwei Ye committed
59
  /*! \brief Main predicting logic */
Guolin Ke's avatar
Guolin Ke committed
60
61
62
63
64
  void Predict();

  /*! \brief All configs */
  OverallConfig config_;
  /*! \brief Training data */
Guolin Ke's avatar
Guolin Ke committed
65
  std::unique_ptr<Dataset> train_data_;
Guolin Ke's avatar
Guolin Ke committed
66
  /*! \brief Validation data */
Guolin Ke's avatar
Guolin Ke committed
67
  std::vector<std::unique_ptr<Dataset>> valid_datas_;
Guolin Ke's avatar
Guolin Ke committed
68
  /*! \brief Metric for training data */
Guolin Ke's avatar
Guolin Ke committed
69
  std::vector<std::unique_ptr<Metric>> train_metric_;
Guolin Ke's avatar
Guolin Ke committed
70
  /*! \brief Metrics for validation data */
Guolin Ke's avatar
Guolin Ke committed
71
  std::vector<std::vector<std::unique_ptr<Metric>>> valid_metrics_;
Guolin Ke's avatar
Guolin Ke committed
72
  /*! \brief Boosting object */
Guolin Ke's avatar
Guolin Ke committed
73
  std::unique_ptr<Boosting> boosting_;
Guolin Ke's avatar
Guolin Ke committed
74
  /*! \brief Training objective function */
Guolin Ke's avatar
Guolin Ke committed
75
  std::unique_ptr<ObjectiveFunction> objective_fun_;
Guolin Ke's avatar
Guolin Ke committed
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
};


inline void Application::Run() {
  if (config_.task_type == TaskType::kPredict) {
    InitPredict();
    Predict();
  } else {
    InitTrain();
    Train();
  }
}

}  // namespace LightGBM

Guolin Ke's avatar
Guolin Ke committed
91
#endif   // LightGBM_APPLICATION_H_