Skip to content

Commit 1b9b737

Browse files
[doc][jvm] Explanation for isMaximizeEvaluation. (#11691)
1 parent e4dc7b6 commit 1b9b737

File tree

1 file changed

+10
-0
lines changed
  • jvm-packages/xgboost4j/src/main/java/ml/dmlc/xgboost4j/java

1 file changed

+10
-0
lines changed

jvm-packages/xgboost4j/src/main/java/ml/dmlc/xgboost4j/java/XGBoost.java

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,16 @@ private static String getMetricNameFromlog(String evalInfo, String[] evalNames)
386386
}
387387

388388
// visiable for testing
389+
390+
/**
391+
* Decides whether the evaluation metrics are to be maximized or not.
392+
*
393+
* @param evalInfo The evaluation log string from which the metric name is inferred.
394+
* @param evalNames The names of the evaluation matrices.
395+
* @param params The parameters that contain information regarding whether the
396+
* evaluation metrics are to be maximized or not.
397+
* @return True if the evaluation metrics are to be maximized, false otherwise.
398+
*/
389399
public static boolean isMaximizeEvaluation(String evalInfo,
390400
String[] evalNames,
391401
Map<String, Object> params) {

0 commit comments

Comments
 (0)