GetFunc(获取型函数)

原理

  1. 请求划分

    参数服务器的接口，操作的是整个模型参数。而模型参数是被划分成多个分区存储在不同的PS实例中的，因此在请求阶段，就要进行划分了

    • PS Client（参数服务器客户端）进行请求划分，生成一个请求列表，这个请求列表中，每一个请求都和一个模型参数分区对应

  2. 请求发送

    • Angel将请求列表中的所有请求，发送给模型参数分区所在的PS实例。
    • PS实例以模型参数分区为单位执行参数获取和更新操作，并返回相应的结果。

  3. 结果合并

    • 合并所有的模型分区级结果，得到最终的结果并返回

定义

  • 接口

    1.   GetResult get(GetFunc get) throws AngelException;

  • 参数

    • get型psFunc的参数类型是一个GetFunc对象，该对象封装了get psf方法的参数和执行流程：

      1.   public abstract class GetFunc {
      2.     protected final GetParam param;
      3.     public GetFunc(GetParam param) {
      4.       this.param = param;
      5.     }
      6.     public GetParam getParam() {return param;}
      7.     public abstract PartitionGetResult partitionGet(PartitionGetParam partParam);
      8.     public abstract GetResult merge(List<PartitionGetResult> partResults);
      9.   }

    • GetFunc对象的参数类型为GetParam

      • GetParam实现了ParamSplit接口，ParamSplit接口定义了一个split方法，该方法的含义是将一个针对整个矩阵的全局的参数划分成一个矩阵分区参数列表。
      • GetParam类型提供了一个默认的split接口实现，也就是针对该矩阵的每一个分区都生成一个矩阵分区的参数。
      • get psf的矩阵分区参数是一个PartitionGetParam类型。

执行流程

get型psFunc的执行流程分为两步，分别由接口partitionGet和merge方法表示。

  • partitionGet方法定义了从一个矩阵分区获取所需结果的具体流程，它的返回结果类型为PartitionGetResult
  • merge方法定义了如何将各个矩阵分区的结果合并得到完整结果的过程。完整的结果类型为GetResult

这2步分别需要Worker端和PSServer端完成：

  • 参数划分和Merge方法是在Worker端执行
  • partitionGet是在PS端执行

具体的流程如下图所示，左子图表示Worker端处理流程，右子图表示PS端处理流程：

GetFunc(获取型函数) - 图1

编程样例

由于getFunc的接口太底层，建议普通用户，从AggrFunc开始继承编写psFunc，这样需要Cover的细节较少

  1. public final class Sum extends UnaryAggrFunc {
  2.   ...
  3.   @Override
  4.   public GetResult merge(List<PartitionGetResult> partResults) {
  5.     double sum = 0.0;
  6.     for (PartitionGetResult partResult ： partResults) {
  7.       sum += ((ScalarPartitionAggrResult) partResult).result;
  8.     }
  10.     return new ScalarAggrResult(sum);
  11.   }

将代码编译后打成jar包，在提交任务时通过参数—angel.lib.jars上传该jar包，然后就可以在应用程序中调用了。调用方式如下：

  1.     Sum sumFunc = new Sum(new SumParam(matrixId, rowIndex));
  2.     double result = ((SumResult)psModel.get(sumFunc)).getResult();

内置库

  • Amax

    • 功能：获取矩阵某一行的元素的最大绝对值
    • 参数：矩阵id，行号
    • 返回值：最大绝对值

  • Amin

    • 功能：获取矩阵某一行的元素的最小绝对值
    • 参数：矩阵id，行号
    • 返回值：最小绝对值

  • Asum

    • 功能：获取矩阵某一行的元素的绝对值之和
    • 参数：矩阵id，行号
    • 返回值：指定行的元素绝对值之和

  • Max

    • 功能：获取矩阵某一行的元素的最大值
    • 参数：矩阵id，行号
    • 返回值：最大值

  • Min

    • 功能：获取矩阵某一行的元素的最小值
    • 参数：矩阵id，行号
    • 返回值：最小值

  • Sum

    • 功能：获取矩阵某一行的元素之和
    • 参数：矩阵id，行号
    • 返回值：指定行的元素之和

  • Dot

    • 功能：获取矩阵某两个行向量的内积
    • 参数：矩阵id，行号1， 行号2
    • 返回值：指定某两个行向量的内积

  • Nnz

    • 功能：获取矩阵某一行的元素中非零值的总数
    • 参数：矩阵id，行号
    • 返回值：非零值的总数

  • Nrm2

    • 功能：获取矩阵某一行的元素的L2范数
    • 参数：矩阵id，行号
    • 返回值：L2范数