xgboost4j_2.12 1.4.1 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package ml
  Definition Classes
    root
-  package dmlc
  Definition Classes
    ml
-  package xgboost4j
  Definition Classes
    dmlc
-  package java
  Definition Classes
    xgboost4j
-  package util
- Booster
- DMatrix
- ExternalCheckpointManager
- GpuTestSuite
- IEvaluation
- IObjective
- IRabitTracker
- Rabit
- RabitTracker
- TrackerProperties
- XGBoost
- XGBoostError
-  package scala
  Definition Classes
    xgboost4j

p

ml.dmlc.xgboost4j

# java 

#### package java

### Type Members

1.  class Booster extends Serializable with KryoSerializable

   Booster for xgboost, this is a model API that support interactive build of a XGBoost Model

2.  class DMatrix extends AnyRef

   DMatrix for xgboost.

3.  class ExternalCheckpointManager extends AnyRef
4.  class GpuTestSuite extends Annotation with Annotation with ClassfileAnnotation
5.  trait IEvaluation extends Serializable

   interface for customized evaluation

6.  trait IObjective extends Serializable

   interface for customize Object function

7.  trait IRabitTracker extends UncaughtExceptionHandler

   Interface for Rabit tracker implementations with three public methods:

   Interface for Rabit tracker implementations with three public methods:

   - start(timeout): Start the Rabit tracker awaiting for worker connections, with a given timeout value (in milliseconds.)
   - getWorkerEnvs(): Return the environment variables needed to initialize Rabit clients.
   - waitFor(timeout): Wait for the task execution by the worker nodes for at most `timeout` milliseconds.

   Each implementation is expected to implement a callback function

   public void uncaughtException(Threat t, Throwable e) { ... }

   to interrupt waitFor() in order to prevent the tracker from hanging indefinitely.

   The Rabit tracker handles connections from distributed workers, assigns ranks to workers, and brokers connections between workers.

8.  class Rabit extends AnyRef

   Rabit global class for synchronization.

9.  class RabitTracker extends IRabitTracker

   Java implementation of the Rabit tracker to coordinate distributed workers.

   Java implementation of the Rabit tracker to coordinate distributed workers. As a wrapper of the Python Rabit tracker, this implementation does not handle timeout for both start() and waitFor() methods (i.e., the timeout is infinite.)

   For systems lacking Python environment, or for timeout functionality, consider using the Scala Rabit tracker (ml.dmlc.xgboost4j.scala.rabit.RabitTracker) which does not depend on Python, and provides timeout support.

   The tracker must be started on driver node before running distributed jobs.

10.  class TrackerProperties extends AnyRef
11.  class XGBoost extends AnyRef

    trainer for xgboost

12.  class XGBoostError extends Exception

    custom error class for xgboost

### Ungrouped