ml.dmlc.xgboost4j.java

类 Communicator

java.lang.Object

ml.dmlc.xgboost4j.java.Communicator

public class Communicator
extends Object

用于同步的集体通信器全局类。目前通信器 API 处于实验阶段，函数签名将来可能会在不另行通知的情况下发生变化。

嵌套类摘要

嵌套类

修饰符和类型	类和说明
static class	Communicator.DataType
static class	Communicator.OpType

构造方法摘要

构造方法

构造方法和说明
Communicator()

方法摘要

修饰符和类型	方法和说明
static float[]	allReduce(float[] elements, Communicator.OpType op) 使用运算符 op 对分布式 float 向量执行 Allreduce 操作。
static void	communicatorPrint(String msg) 通过通信器打印消息。
static int	getRank() 获取当前线程的 rank。
static int	getWorldSize() 获取当前作业的 world size。
static void	init(Map<String,Object> envs) 在当前工作线程上初始化集体通信器。
static void	shutdown() 在当前工作线程中关闭通信器，等同于 finalize。

从类 java.lang.Object 继承的方法

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造方法详细信息

Communicator

public Communicator()

方法详细信息

init

public static void init(Map<String,Object> envs)
                 throws XGBoostError

在当前工作线程上初始化集体通信器。

参数

envs - 要传递给通信器的附加环境变量。

抛出

XGBoostError

shutdown

public static void shutdown()
                     throws XGBoostError

在当前工作线程中关闭通信器，等同于 finalize。

抛出

XGBoostError

communicatorPrint

public static void communicatorPrint(String msg)
                              throws XGBoostError

通过通信器打印消息。

参数

msg -

抛出

XGBoostError

getRank

public static int getRank()
                   throws XGBoostError

获取当前线程的 rank。

返回

rank。

抛出

XGBoostError

getWorldSize

public static int getWorldSize()
                        throws XGBoostError

获取当前作业的 world size。

返回

worldsize

抛出

XGBoostError

allReduce

public static float[] allReduce(float[] elements,
                                Communicator.OpType op)

使用运算符 op 对分布式 float 向量执行 Allreduce 操作。

参数

elements - 分布式工作节点上的本地元素。

op - 用于 Allreduce 操作的运算符。

返回

根据给定的运算符进行 Allreduce 操作后的 float 元素。