dmlc / dmlc/xgboost

[jvm-packages] Spark Scaladoc Value Member Groups

Open
#4,780 0 comments 0 reactions 0 assignees View on GitHub
doc
Dominant language
C++
Stars
28.8k
Forks
8.9k
Avg merge
1d 12h
Merged PRs (30d)
54

Description

Currently we have no grouping for value members of classes like `XGBoostClassificationModel` and `XGBoostRegressionModel`, this makes the docs quite hard to look at:

![image](https://user-images.githubusercontent.com/5735406/63139064-01583800-c031-11e9-89cc-ff49ff66c1ab.png)

If we compare this with the official spark docs, you can see groupings for things like 'paramaters', 'getters/setters', etc: [GBTClassificationModel Scala Docs](https://spark.apache.org/docs/2.4.3/api/scala/index.html#org.apache.spark.ml.classification.GBTClassificationModel)

Adding this is quite easy, but a little tedious, you need to add `@group` decorators like the following: https://github.com/apache/spark/blob/v2.4.3/mllib/src/main/scala/org/apache/spark/ml/classification/GBTClassifier.scala#L70

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.