improve docs and add comments

Xtra-Computing · Jan 23, 2019 · 9c4e5b2 · 9c4e5b2
1 parent bcfaf37
commit 9c4e5b2
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -6,6 +6,12 @@ ThunderGBM is dedicated to helping users apply GBDTs and Random Forests to solve
 * Supported Operating Systems: Linux.
 * ThunderGBM is often 10 times faster than XGBoost, LightGBM and CatBoost. It has excellent performance on handling high dimensional and sparse problems.
 
+<div align="center">
+<img src="https://github.com/zeyiwen/thundergbm/blob/master/docs/_static/tgbm-logo.png" width="240" height="200" align=left/>
+<img src="https://github.com/zeyiwen/thundergbm/blob/master/docs/_static/lang-logo-tgbm.png" width="270" height="200" align=left/>
+<img src="https://github.com/zeyiwen/thundergbm/blob/master/docs/_static/overall.png" width="250" height="200" align=left/>
+</div>
+
 ## More information about ThunderGBM
 * [Parameters](parameters.md)
 * [How To](how-to.md)

diff --git a/include/thundergbm/objective/objective_function.h b/include/thundergbm/objective/objective_function.h
@@ -19,6 +19,8 @@ class ObjectiveFunction {
     virtual string default_metric_name() = 0;
 
     static ObjectiveFunction* create(string name);
+
+    //a file containing the number of instances per query; similar to XGBoost
     static bool need_load_group_file(string name);
     static bool need_group_label(string name);
     virtual ~ObjectiveFunction() = default;

diff --git a/include/thundergbm/syncarray.h b/include/thundergbm/syncarray.h
@@ -168,6 +168,7 @@ class SyncArray : public el::Loggable {
     size_t size_;
 };
 
+//SyncArray for multiple devices
 template<typename T>
 class MSyncArray : public vector<SyncArray<T>> {
 public:

diff --git a/include/thundergbm/updater/function_builder.h b/include/thundergbm/updater/function_builder.h
@@ -9,6 +9,9 @@
 #include "thundergbm/common.h"
 #include "thundergbm/sparse_columns.h"
 
+/**
+ * @brief: support different ways of building the trees
+ */
 class FunctionBuilder {
 public:
     virtual vector<Tree> build_approximate(const MSyncArray<GHPair> &gradients) = 0;

diff --git a/src/thundergbm/trainer.cu b/src/thundergbm/trainer.cu
@@ -38,6 +38,7 @@ void TreeTrainer::train(GBMParam &param) {
     std::chrono::high_resolution_clock timer;
     auto start = timer.now();
     for (int i = 0; i < param.n_trees; ++i) {
+        //one iteration may produce multiple trees, depending on objectives
         booster.boost(boosted_model);
     }
     auto stop = timer.now();