ml.dmlc.xgboost4j.java

类 Communicator

java.lang.Object

ml.dmlc.xgboost4j.java.Communicator

public class Communicator
extends Object

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

嵌套类摘要

嵌套类

修饰符和类型	类和描述
静态类	Communicator.DataType
静态类	Communicator.OpType

构造器摘要

构造器

构造器和说明
Communicator()

方法摘要

修饰符和类型	方法和说明
static float[]	allReduce(float[] elements, Communicator.OpType op) 使用运算符 op 对分布式浮点向量执行 Allreduce。
static void	communicatorPrint(String msg) 通过通信器打印消息。
static int	getRank() 获取当前线程的排名。
static int	getWorldSize() 获取当前作业的世界大小。
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

获取当前线程的排名。

返回

排名。

抛出

XGBoostError

getWorldSize

public static int getWorldSize()
                        throws XGBoostError

获取当前作业的世界大小。

返回

世界大小

抛出

XGBoostError

allReduce

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

使用运算符 op 对分布式浮点向量执行 Allreduce。

参数

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

op - 用于 Allreduce 的运算符。

返回

根据给定运算符进行 All-reduce 的浮点元素。