MatmulReduceScatter

产品支持情况

产品	是否支持
Ascend 950PR/Ascend 950DT	√
Atlas A3 训练系列产品/Atlas A3 推理系列产品	√
Atlas A2 训练系列产品/Atlas A2 推理系列产品	√
Atlas 200I/500 A2 推理产品	×
Atlas 推理系列产品	×
Atlas 训练系列产品	×

说明： 使用该接口时，请确保驱动固件包和CANN包都为配套的8.0.RC2版本或者配套的更高版本，否则将会引发报错，比如Bus Error等。

功能说明

接口功能：完成Matmul计算和ReduceScatter通信的融合，先计算后通信。融合算子内部实现计算和通信流水并行。
计算公式：

$o u t p u t = R e d u c e S c a t t e r (x 1 @ x 2 + b i a s)$
- x1指Matmul计算的左矩阵。
- x2指Matmul计算的右矩阵。
- bias指Matmul计算的偏置。

函数原型

每个算子分为两段式接口，必须先调用“aclnnMatmulReduceScatterGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnMatmulReduceScatter”接口执行计算。

aclnnStatus aclnnMatmulReduceScatterGetWorkspaceSize(
    const aclTensor* x1,
    const aclTensor* x2,
    const aclTensor* bias,
    const char*      group,
    const char*      reduceOp,
    int64_t          commTurn,
    int64_t          streamMode,
    const aclTensor* output,
    uint64_t*        workspaceSize,
    aclOpExecutor**  executor)

aclnnStatus aclnnMatmulReduceScatter(
    void*           workspace,
    uint64_t        workspaceSize,
    aclOpExecutor*  executor,
    aclrtStream     stream)

aclnnMatmulReduceScatterGetWorkspaceSize

参数说明

参数名	输入/输出	描述	使用说明	数据类型	数据格式	维度(shape)	非连续Tensor
x1	输入	Matmul计算的左矩阵输入，即计算公式中的x1。	shape为（m，k）。支持空Tensor。	FLOAT16、BFLOAT16	ND	2	×
x2	输入	Matmul计算的右矩阵输入，即计算公式中的x2。	不转置场景的shape为（k，n），转置场景的shape为（n，k）。支持空Tensor。与x1的数据类型保持一致。当前版本仅支持二维输入，支持转置/不转置场景。仅支持两根轴转置情况下的非连续的Tensor，其他场景的非连续的Tensor不支持。	FLOAT16、BFLOAT16	ND	2	√（仅适用转置场景）
bias	输入	Matmul计算的偏置，即计算公式中的bias。	shape为（n）。支持传入空指针场景。 Atlas A2 训练系列产品/Atlas A2 推理系列产品、Atlas A3 训练系列产品/Atlas A3 推理系列产品：暂不支持输入为非0的场景。 Ascend 950PR/Ascend 950DT：支持输入为非0的场景。	FLOAT16、BFLOAT16	ND	1	×
group	输入	通信域名称。	通过Hccl提供的接口“extern HcclResult HcclGetCommName(HcclComm comm, char* commName);”获取，其中commName即为group。	-	-	-	-
reduceOp	输入	reduce操作类型。	当前版本仅支持“sum”。	-	-	-	-
commTurn	输入	通信数据切分数，即总数据量/单次通信量。	当前版本仅支持输入0。	-	-	-	-
streamMode	输入	流模式的枚举。	streamMode：任务失败后的流处理模式。取值范围如下： 1表示ACL_STOP_ON_FAILURE，某个任务失败后，停止执行后续的任务。此模式为当前版本唯一支持的值。	-	-	-	-
output	输出	AllGather通信与MatMul计算的结果，即计算公式中的output。	shape为(m/rank_size, n)。支持空Tensor。与x1的数据类型保持一致。	FLOAT16、BFLOAT16	ND	2	×
workspaceSize	输出	返回需要在Device侧申请的workspace大小。	-	-	-	-	-
executor	输出	返回op执行器，包含了算子计算流程。	-	-	-	-	-

返回值

返回aclnnStatus状态码，具体参见aclnn返回码。

第一段接口完成入参校验，出现以下场景时报错：

返回值	错误码	描述
ACLNN_ERR_PARAM_NULLPTR	161001	传入的x1、x2或output是空指针。
ACLNN_ERR_PARAM_INVALID	161002	x1、x2、bias或output的数据类型不在支持的范围之内。
		streamMode不在合法范围内。
		x1、x2或output的shape不符合约束要求。

aclnnMatmulReduceScatter

参数说明

参数名	输入/输出	描述
workspace	输入	在Device侧申请的workspace内存地址。
workspaceSize	输入	在Device侧申请的workspace大小，由第一段接口`aclnnMatmulReduceScatterGetWorkspaceSize`获取。
executor	输入	op执行器，包含了算子计算流程。
stream	输入	指定执行任务的stream。

返回值：

返回aclnnStatus状态码，具体参见aclnn返回码。

约束说明

通信引擎约束：
- Atlas A2 训练系列产品/Atlas A2 推理系列产品：仅支持AICPU通信。
- Atlas A3 训练系列产品/Atlas A3 推理系列产品：仅支持AICPU通信。
- Ascend 950PR/Ascend 950DT：仅支持CCU通信。
参数说明中shape涉及的变量说明：
- m为卡数rank_size的整数倍。
- k的取值范围为[256, 65535)。
- x1/x2支持的空tensor场景，m和n可以为0，k不可为0，且需满足以下条件：
  - m为0，k不为0，n不为0；
  - m不为0，k不为0，n为0；
  - m为0，k不为0，n为0。
- rank_size为卡数。
x2支持转置/不转置场景，x1只支持不转置场景。
x1、x2计算输入的数据类型要和output计算输出的数据类型一致。
Atlas A2 训练系列产品/Atlas A2 推理系列产品：
- 支持2、4、8卡，并且仅支持hccs链路all mesh组网。
- 一个模型中的通算融合MC2算子，仅支持相同通信域。
- aclnnMatmulReduceScatter默认非确定性实现，支持通过aclrtCtxSetSysParamOpt开启确定性。
Atlas A3 训练系列产品/Atlas A3 推理系列产品：
- 支持2、4、8、16、32卡，并且仅支持hccs链路double ring组网。
- aclnnMatmulReduceScatter默认非确定性实现，支持通过aclrtCtxSetSysParamOpt开启确定性。
Ascend 950PR/Ascend 950DT：支持2、4、8、16、32、64卡，并且仅支持hccs链路all mesh组网。
- ReduceScatter集合通信数据总量不能超过16*256MB，集合通信数据总量计算方式为：m * n * sizeof(output_dtype)。由于shape不同，算子内部实现可能存在差异，实际支持的总通信量可能略小于该值。
- aclnnMatmulReduceScatter默认为确定性实现。

调用说明

调用方式	样例代码	说明
aclnn接口	test_aclnn_matmul_reduce_scatter.cpp	通过aclnnMatmulReduceScatter接口方式调用matmul_reduce_scatter算子。