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
  Definition Classes
    java
- Booster
- DMatrix
- ExternalCheckpointManager
- GpuTestSuite
- IEvaluation
- IObjective
- IRabitTracker
- Rabit
- RabitTracker
- TrackerProperties
- XGBoost
- XGBoostError

t

ml.dmlc.xgboost4j.java

# IRabitTracker 

###

#### trait IRabitTracker extends UncaughtExceptionHandler

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.

Linear Supertypes
UncaughtExceptionHandler, AnyRef, Any
Known Subclasses
RabitTracker
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. IRabitTracker
2. UncaughtExceptionHandler
3. AnyRef
4. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Type Members

1.  type TrackerStatus = IRabitTracker.TrackerStatus
   Attributes
     protected

### Abstract Value Members

1.  abstract def getWorkerEnvs(): Map[String, String]
2.  abstract def start(workerConnectionTimeout: Long): Boolean
3.  abstract def stop(): Unit
4.  abstract def uncaughtException(arg0: Thread, arg1: Throwable): Unit
   Definition Classes
     UncaughtExceptionHandler
5.  abstract def waitFor(taskExecutionTimeout: Long): Int

### Concrete Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
6.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
7.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
8.  def finalize(): Unit
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( classOf[java.lang.Throwable] )
9.  final def getClass(): Class[_]
   Definition Classes
     AnyRef → Any
   Annotations
     @native()
10.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
11.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
12.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
14.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
15.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
16.  def toString(): String
    Definition Classes
      AnyRef → Any
17.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
18.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
19.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from UncaughtExceptionHandler

### Inherited from AnyRef

### Inherited from Any

### Ungrouped