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

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

#include <vector>

namespace LightGBM {

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

/*!
Qiwei Ye's avatar
Qiwei Ye committed
18
* \brief The main entrance of LightGBM. this application has two tasks:
19
20
21
22
*        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
23
24
25
26
27
28
29
30
31
32
33
34
35
*/
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
36
  * \brief Global Sync by minimal, will return minimal T across nodes
Guolin Ke's avatar
Guolin Ke committed
37
  * \param local Local data
Qiwei Ye's avatar
Qiwei Ye committed
38
  * \return minimal values across nodes 
Guolin Ke's avatar
Guolin Ke committed
39
40
41
42
43
44
45
46
47
48
  */
  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
49
  /*! \brief Initialization before training*/
Guolin Ke's avatar
Guolin Ke committed
50
51
  void InitTrain();

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

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

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

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


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

}  // namespace LightGBM

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