Skip to content

Commit 3720845

Browse files
committed
Improve javadoc for GBTClassifier and GBTRegressor.
1 parent 47d0870 commit 3720845

2 files changed

Lines changed: 34 additions & 2 deletions

File tree

flink-ml-lib/src/main/java/org/apache/flink/ml/classification/gbtclassifier/GBTClassifier.java

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,23 @@
3636

3737
import static org.apache.flink.table.api.Expressions.$;
3838

39-
/** An Estimator which implements the gradient boosting trees classification algorithm. */
39+
/**
40+
* An Estimator which implements the gradient boosting trees classification algorithm (<a
41+
* href="http://en.wikipedia.org/wiki/Gradient_boosting">Gradient Boosting</a>).
42+
*
43+
* <p>The implementation has been inspired by advanced implementations like <a
44+
* href="https://www.kdd.org/kdd2016/papers/files/rfp0697-chenAemb.pdf">XGBoost</a> and <a
45+
* href="https://proceedings.neurips.cc/paper/2017/file/6449f44a102fde848669bdd9eb6b76fa-Paper.pdf">LightGBM</a>.
46+
* It supports features like regularized learning objective with second-order approximation,
47+
* histogram-based and sparsity-aware split-finding algorithm.
48+
*
49+
* <p>The implementation of distributed system takes <a
50+
* href="http://www.vldb.org/pvldb/vol12/p1357-fu.pdf">this work</a> as a reference. Right now, we
51+
* support horizontal partition of data and row-store storage of instances.
52+
*
53+
* <p>NOTE: Currently, some features are not supported yet: weighted input samples, early-stopping
54+
* with validation set, encoding with leaf ids, etc.
55+
*/
4056
public class GBTClassifier
4157
implements Estimator<GBTClassifier, GBTClassifierModel>,
4258
GBTClassifierParams<GBTClassifier> {

flink-ml-lib/src/main/java/org/apache/flink/ml/regression/gbtregressor/GBTRegressor.java

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,23 @@
3636

3737
import static org.apache.flink.table.api.Expressions.$;
3838

39-
/** An Estimator which implements the gradient boosting trees regression algorithm. */
39+
/**
40+
* An Estimator which implements the gradient boosting trees regression algorithm (<a
41+
* href="http://en.wikipedia.org/wiki/Gradient_boosting">Gradient Boosting</a>).
42+
*
43+
* <p>The implementation has been inspired by advanced implementations like <a
44+
* href="https://www.kdd.org/kdd2016/papers/files/rfp0697-chenAemb.pdf">XGBoost</a> and <a
45+
* href="https://proceedings.neurips.cc/paper/2017/file/6449f44a102fde848669bdd9eb6b76fa-Paper.pdf">LightGBM</a>.
46+
* It supports features like regularized learning objective with second-order approximation,
47+
* histogram-based and sparsity-aware split-finding algorithm.
48+
*
49+
* <p>The implementation of distributed system takes <a
50+
* href="http://www.vldb.org/pvldb/vol12/p1357-fu.pdf">this work</a> as a reference. Right now, we
51+
* support horizontal partition of data and row-store storage of instances.
52+
*
53+
* <p>NOTE: Currently, some features are not supported yet: weighted input samples, early-stopping
54+
* with validation set, encoding with leaf ids, etc.
55+
*/
4056
public class GBTRegressor
4157
implements Estimator<GBTRegressor, GBTRegressorModel>, GBTRegressorParams<GBTRegressor> {
4258

0 commit comments

Comments
 (0)