aclnnBidirectionLSTM.md

支持的产品型号

Atlas 推理系列产品。

接口原型

每个算子分为undefined，必须先调用“aclnnBidirectionLSTMGetWorkspaceSize”接口获取入参并根据流程计算所需workspace大小，再调用“aclnnBidirectionLSTM”接口执行计算。

aclnnStatus aclnnBidirectionLSTMGetWorkspaceSize(const aclTensor *x, const aclTensor *initH, const aclTensor *initC, const aclTensor *wIh, const aclTensor *wHh, const aclTensor *bIhOptional, const aclTensor *bHhOptional, const aclTensor *wIhReverseOptional, const aclTensor *wHhReverseOptional, const aclTensor *bIhReverseOptional, const aclTensor *bHhReverseOptional, int64_t numLayers, bool isbias, bool batchFirst, bool bidirection, const aclTensor *y, const aclTensor *outputH, const aclTensor *outputC, uint64_t *workspaceSize, aclOpExecutor **executor);
aclnnStatus aclnnBidirectionLSTM(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, const aclrtStream stream);

功能描述

算子功能： LSTM（Long Short-Term Memory，长短时记忆）网络是一种特殊的循环神经网络(RNN)模型。

aclnnBidirectionLSTMGetWorkspaceSize

参数说明：
- x(const aclTensor *, 计算输入): Device侧的aclTensor，输入，数据类型支持FLOAT16，shape支持三维(time_step, batch_size, input_size)。只支持连续Tensor，数据格式支持ND。
- initH(const aclTensor *, 计算输入): Device侧的aclTensor，初始化hidden状态，数据类型支持FLOAT16，shape支持三维(num_layers, batch_size, hidden_size)或者当bidirection为True时(2 * num_layers, batch_size, hidden_size)。只支持连续Tensor，数据格式支持ND。
- initC(const aclTensor *, 计算输入): Device侧的aclTensor，初始化cell状态，数据类型支持FLOAT16，shape支持三维(num_layers, batch_size, hidden_size)或者当bidirection为True时(2 * num_layers, batch_size, hidden_size)。只支持连续Tensor，数据格式支持ND。
- wIh(const aclTensor *, 计算输入): Device侧的aclTensor，input-hidden权重，数据类型支持FLOAT16，shape支持二维(4 * hidden_size, input_size)。只支持连续Tensor，数据格式支持ND。
- wHh(const aclTensor *, 计算输入): Device侧的aclTensor，hidden-hidden权重，数据类型支持FLOAT16，shape支持二维(4 * hidden_size, hidden_size)。只支持连续Tensor，数据格式支持ND。
- bIhOptional(const aclTensor *, 计算输入): Device侧的aclTensor，input-hidden偏移, 数据类型支持FLOAT16，shape支持一维(4 * hidden_size)。只支持连续Tensor，数据格式支持ND。
- bHhOptional(const aclTensor *, 计算输入): Device侧的aclTensor，hidden-hidden偏移, 数据类型支持FLOAT16，shape支持一维(4 * hidden_size)。只支持连续Tensor，数据格式支持ND。
- wIhReverseOptional(const aclTensor *, 计算输入): Device侧的aclTensor，逆向input-hidden权重，数据类型支持FLOAT16，shape支持二维(4 * hidden_size, input_size)。只支持连续Tensor，数据格式支持ND。
- wHhReverseOptional(const aclTensor *, 计算输入): Device侧的aclTensor，逆向hidden-hidden权重，数据类型支持FLOAT16，shape支持二维(4 * hidden_size, input_size)。只支持连续Tensor，数据格式支持ND。
- bIhReverseOptional(const aclTensor *, 计算输入): Device侧的aclTensor，逆向hidden-hidden偏移，数据类型支持FLOAT16，shape支持一维(4 * hidden_size)。只支持连续Tensor，数据格式支持ND。
- bHhReverseOptional(const aclTensor *, 计算输入): Device侧的aclTensor，逆向hidden-hidden偏移，数据类型支持FLOAT16，shape支持一维(4 * hidden_size)。只支持连续Tensor，数据格式支持ND。
- numLayers(int64_t, 计算输入): Host侧的整型，当前只支持1，类型支持int64_t。
- isbias(bool, 计算输入): Host侧的BOOL，表示是否有bias，类型支持BOOL。
- batchFirst(bool, 计算输入): Host侧的BOOL，表示batch是否是第一维，当前只支持false，类型支持BOOL。
- bidirection(bool, 计算输入): Host侧的BOOL，表示是否是双向，类型支持BOOL。
- y(const aclTensor *, 计算输出): Device侧的aclTensor，输出，数据类型支持FLOAT16，shape支持三维(time_step, batch_size, hidden_size)或者当bidirection为True时(time_step, batch_size, 2 * hidden_size)。只支持连续Tensor，数据格式支持ND。
- outputH(const aclTensor *, 计算输出): Device侧的aclTensor，最终hidden状态，数据类型支持FLOAT16，shape支持三维(num_layers, batch_size, hidden_size)或者当bidirection为True时(2 * num_layers, batch_size, hidden_size)。只支持连续Tensor，数据格式支持ND。
- outputC(const aclTensor *, 计算输出): Device侧的aclTensor，最终cell状态，数据类型支持FLOAT16，shape支持三维(num_layers, batch_size, hidden_size)或者当bidirection为True时(2 * num_layers, batch_size, hidden_size)。只支持连续Tensor，数据格式支持ND。
- workspaceSize(uint64_t *, 出参): 返回需要在Device侧申请的workspace大小。
- executor(aclOpExecutor **, 出参): 返回op执行器，包含了算子计算流程。
返回值：

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

aclnnBidirectionLSTM

参数说明：
- workspace(void *, 入参): 在Device侧申请的workspace内存地址。
- workspaceSize(uint64_t, 入参): 在Device侧申请的workspace大小，由第一段接口aclnnBidirectionLSTMGetWorkspaceSize获取。
- executor(aclOpExecutor *, 入参): op执行器，包含了算子计算流程。
- stream(aclrtStream , 入参): 指定执行任务的 AscendCL Stream流。
返回值：

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

约束与限制

调用示例

示例代码如下，仅供参考，具体编译和执行过程请参考undefined。

[object Object]