Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions infiniop/ops/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,12 @@
- [`Softmax`](/infiniop/ops/softmax/README.md)
- [`Sub`](/infiniop/ops/sub/README.md)
- [`SwiGLU`](/infiniop/ops/swiglu/README.md)
- [`Silu`](/infiniop/ops/silu/README.md)
- [`Div`](/infiniop/ops/div/README.md)
- [`And`](/infiniop/ops/and/README.md)
- [`Or`](/infiniop/ops/or/README.md)
- [`Equal`](/infiniop/ops/equal/README.md)
- [`ReLUBackward`](/infiniop/ops/relu_backward/README.md)
- [`GeLU`](/infiniop/ops/gelu/README.md)
- [`GeLUBackward`](/infiniop/ops/gelu_backward/README.md)
- [`CrossEntropyLossBackward`](/infiniop/ops/cross_entropy_loss_backward/README.md)
127 changes: 127 additions & 0 deletions infiniop/ops/and/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@

# `And`

`And`, 即**与操作**算子,为双目逐元素算子。其计算可被表述为:

$$ c = a \, \&\& \, b $$

其中 `a` 和 `b` 为输入,`c` 为输出。


## 接口

### 计算

```c
infiniStatus_t infiniopAnd(
infiniopAndDescriptor_t desc,
void *workspace,
size_t workspace_size,
void * c,
const void * a,
const void * b,
void *stream
);
```
<div style="background-color: lightblue; padding: 1px;"> 参数: </div>

- `desc`:
已使用 `infiniopCreateAndDescriptor()` 初始化的算子描述符。
- `workspace`:
指向算子计算所需的额外工作空间;
- `workspace_size`:
`workspace` 的大小,单位:字节;
- `c`:输出张量。张量限制见[创建算子描述](#创建算子描述)部分。
- `a`:输入张量。张量限制见[创建算子描述](#创建算子描述)部分。
- `b`:输入张量。张量限制见[创建算子描述](#创建算子描述)部分。
- `stream`: 计算流/队列。

<div style="background-color: lightblue; padding: 1px;"> 返回值:</div>

- [`INFINI_STATUS_SUCCESS`], [`INFINI_STATUS_BAD_PARAM`], [`INFINI_STATUS_INSUFFICIENT_WORKSPACE`], [`INFINI_STATUS_DEVICE_TYPE_NOT_SUPPORTED`], [`INFINI_STATUS_INTERNAL_ERROR`],[`INFINI_STATUS_BAD_TENSOR_DTYPE`].

---

### 创建算子描述

```c
infiniStatus_t infiniopCreateAndDescriptor(
infiniopHandle_t handle,
infiniopAndDescriptor_t *desc_ptr,
infiniopTensorDescriptor_t c_desc,
infiniopTensorDescriptor_t a_desc,
infiniopTensorDescriptor_t b_desc
);
```
<div style="background-color: lightblue; padding: 1px;"> 参数:</div>

- `handle`:
`infiniopHandle_t` 类型的硬件控柄。详情请看:[`InfiniopHandle_t`]。
- `desc_ptr`:
`infiniopAddDescriptor_t` 指针,指向将被初始化的算子描述符地址;
- `c_desc` - { `bool` | (d1,...,dn) | (...) }:
算子计算参数 `c` 的张量描述,支持原位计算。
- `a_desc` - { `bool` | (d1,...,dn) | (...) }:
算子计算参数 `a` 的张量描述,支持原位计算,支持多向广播。
- `b_desc` - { `bool` | (d1,...,dn) | (...) }:
算子计算参数 `b` 的张量描述,支持原位计算,支持多向广播。


<div style="background-color: lightblue; padding: 1px;"> 返回值:</div>

- [`INFINI_STATUS_SUCCESS`], [`INFINI_STATUS_BAD_PARAM`], [`INFINI_STATUS_BAD_TENSOR_SHAPE`], [`INFINI_STATUS_BAD_TENSOR_DTYPE`], [`INFINI_STATUS_BAD_TENSOR_STRIDES`], [`INFINI_STATUS_DEVICE_TYPE_NOT_SUPPORTED`].
---

### 计算额外工作空间

```c
infiniStatus_t infiniopGetAndWorkspaceSize(
infiniopAndDescriptor_t desc,
size_t *size
);
```
<div style="background-color: lightblue; padding: 1px;"> 参数:</div>

- `desc`: 使用 `infiniopCreateAndDescriptor()` 初始化的算子描述符。
- `size`:
额外空间大小的计算结果的写入地址;

<div style="background-color: lightblue; padding: 1px;"> 返回值:</div>

- [`INFINI_STATUS_SUCCESS`], [`INFINI_STATUS_BAD_PARAM`], [`INFINI_STATUS_DEVICE_TYPE_NOT_SUPPORTED`].

---

### 销毁算子描述符

```c
infiniopStatus_t infiniopDestroyAndDescriptor(
infiniopAndDescriptor_t desc
);
```

<div style="background-color: lightblue; padding: 1px;"> 参数: </div>

- `desc`:
输入。 待销毁的算子描述符;

<div style="background-color: lightblue; padding: 1px;"> 返回值: </div>

- [`INFINI_STATUS_SUCCESS`], [`INFINI_STATUS_DEVICE_TYPE_NOT_SUPPORTED`].

## 已知问题


<!-- 链接 -->
[`InfiniopHandle_t`]: /infiniop/handle/README.md

[`INFINI_STATUS_SUCCESS`]: /common/status/README.md#INFINI_STATUS_SUCCESS
[`INFINI_STATUS_BAD_PARAM`]: /common/status/README.md#INFINI_STATUS_BAD_PARAM
[`INFINI_STATUS_INSUFFICIENT_WORKSPACE`]: /common/status/README.md#INFINI_STATUS_INSUFFICIENT_WORKSPACE
[`INFINI_STATUS_DEVICE_TYPE_NOT_SUPPORTED`]: /common/status/README.md#INFINI_STATUS_DEVICE_TYPE_NOT_SUPPORTED
[`INFINI_STATUS_INTERNAL_ERROR`]: /common/status/README.md#INFINI_STATUS_INTERNAL_ERROR
[`INFINI_STATUS_NULL_POINTER`]: /common/status/README.md#INFINI_STATUS_NULL_POINTER
[`INFINI_STATUS_BAD_TENSOR_SHAPE`]: /common/status/README.md#INFINI_STATUS_BAD_TENSOR_SHAPE
[`INFINI_STATUS_BAD_TENSOR_DTYPE`]: /common/status/README.md#INFINI_STATUS_BAD_TENSOR_DTYPE
[`INFINI_STATUS_BAD_TENSOR_STRIDES`]: /common/status/README.md#INFINI_STATUS_BAD_TENSOR_STRIDES
132 changes: 132 additions & 0 deletions infiniop/ops/cross_entropy_loss_backward/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@

# `Cross Entropy Loss Backward`

`Cross Entropy Loss Backward`, 即`Cross Entropy Loss`的反向传播算子,为双目逐元素算子。其计算方法如下:

$$
\rm{grad\_logits=(probs-target) / N}
$$

其中`probs`为概率,`target`为形状与`logits`相同的one-hot张量。`N`为最后一维长度,即分类数目。

## 接口

### 计算

```c
infiniStatus_t infiniopCrossEntropyLossBackward(
infiniopCrossEntropyLossBackwardDescriptor_t desc,
void *workspace,
size_t workspace_size,
void * grad_logits,
const void * probs,
const void * target,
void *stream
);
```
<div style="background-color: lightblue; padding: 1px;"> 参数: </div>

- `desc`:
已使用 `infiniopCreateCrossEntropyLossBackwardDescriptor()` 初始化的算子描述符。
- `workspace`:
指向算子计算所需的额外工作空间;
- `workspace_size`:
`workspace` 的大小,单位:字节;
- `grad_logits`:输出张量。张量限制见[创建算子描述](#创建算子描述)部分。
- `probs`:输入张量。张量限制见[创建算子描述](#创建算子描述)部分。
- `target`:输入张量。张量限制见[创建算子描述](#创建算子描述)部分。
- `stream`: 计算流/队列。

<div style="background-color: lightblue; padding: 1px;"> 返回值:</div>

- [`INFINI_STATUS_SUCCESS`], [`INFINI_STATUS_BAD_PARAM`], [`INFINI_STATUS_INSUFFICIENT_WORKSPACE`], [`INFINI_STATUS_DEVICE_TYPE_NOT_SUPPORTED`], [`INFINI_STATUS_INTERNAL_ERROR`],[`INFINI_STATUS_BAD_TENSOR_DTYPE`].

---

### 创建算子描述

```c
infiniStatus_t infiniopCreateCrossEntropyLossBackwardDescriptor(
infiniopHandle_t handle,
infiniopCrossEntropyLossBackwardDescriptor_t *desc_ptr,
infiniopTensorDescriptor_t grad_logits_desc,
infiniopTensorDescriptor_t probs_desc,
infiniopTensorDescriptor_t target_desc
);
```
<div style="background-color: lightblue; padding: 1px;"> 参数:</div>

- `handle`:
`infiniopHandle_t` 类型的硬件控柄。详情请看:[`InfiniopHandle_t`]。
- `desc_ptr`:
`infiniopAddDescriptor_t` 指针,指向将被初始化的算子描述符地址;
- `grad_logits_desc` - { dT | (N, C) | (...) }:
算子计算参数 `grad_logits` 的张量描述,支持原位计算。
- `probs_desc` - { dT | (N, C) | (...) }:
算子计算参数 `probs` 的张量描述,支持原位计算,支持多向广播。
- `target_desc` - { dT | (N, C) | (...) }:
算子计算参数 `target` 的张量描述,最后一维符合one-hot形式,支持原位计算,支持多向广播。

参数限制:

- **`dT`**: (`Float16`, `Float32`, `Bfloat16`) 之一
- 输入张量均为2D。

<div style="background-color: lightblue; padding: 1px;"> 返回值:</div>

- [`INFINI_STATUS_SUCCESS`], [`INFINI_STATUS_BAD_PARAM`], [`INFINI_STATUS_BAD_TENSOR_SHAPE`], [`INFINI_STATUS_BAD_TENSOR_DTYPE`], [`INFINI_STATUS_BAD_TENSOR_STRIDES`], [`INFINI_STATUS_DEVICE_TYPE_NOT_SUPPORTED`].
---

### 计算额外工作空间

```c
infiniStatus_t infiniopGetCrossEntropyLossBackwardWorkspaceSize(
infiniopCrossEntropyLossBackwardDescriptor_t desc,
size_t *size
);
```
<div style="background-color: lightblue; padding: 1px;"> 参数:</div>

- `desc`: 使用 `infiniopCreateCrossEntropyLossBackwardDescriptor()` 初始化的算子描述符。
- `size`:
额外空间大小的计算结果的写入地址;

<div style="background-color: lightblue; padding: 1px;"> 返回值:</div>

- [`INFINI_STATUS_SUCCESS`], [`INFINI_STATUS_BAD_PARAM`], [`INFINI_STATUS_DEVICE_TYPE_NOT_SUPPORTED`].

---

### 销毁算子描述符

```c
infiniopStatus_t infiniopDestroyCrossEntropyLossBackwardDescriptor(
infiniopCrossEntropyLossBackwardDescriptor_t desc
);
```

<div style="background-color: lightblue; padding: 1px;"> 参数: </div>

- `desc`:
输入。 待销毁的算子描述符;

<div style="background-color: lightblue; padding: 1px;"> 返回值: </div>

- [`INFINI_STATUS_SUCCESS`], [`INFINI_STATUS_DEVICE_TYPE_NOT_SUPPORTED`].

## 已知问题


<!-- 链接 -->
[`InfiniopHandle_t`]: /infiniop/handle/README.md

[`INFINI_STATUS_SUCCESS`]: /common/status/README.md#INFINI_STATUS_SUCCESS
[`INFINI_STATUS_BAD_PARAM`]: /common/status/README.md#INFINI_STATUS_BAD_PARAM
[`INFINI_STATUS_INSUFFICIENT_WORKSPACE`]: /common/status/README.md#INFINI_STATUS_INSUFFICIENT_WORKSPACE
[`INFINI_STATUS_DEVICE_TYPE_NOT_SUPPORTED`]: /common/status/README.md#INFINI_STATUS_DEVICE_TYPE_NOT_SUPPORTED
[`INFINI_STATUS_INTERNAL_ERROR`]: /common/status/README.md#INFINI_STATUS_INTERNAL_ERROR
[`INFINI_STATUS_NULL_POINTER`]: /common/status/README.md#INFINI_STATUS_NULL_POINTER
[`INFINI_STATUS_BAD_TENSOR_SHAPE`]: /common/status/README.md#INFINI_STATUS_BAD_TENSOR_SHAPE
[`INFINI_STATUS_BAD_TENSOR_DTYPE`]: /common/status/README.md#INFINI_STATUS_BAD_TENSOR_DTYPE
[`INFINI_STATUS_BAD_TENSOR_STRIDES`]: /common/status/README.md#INFINI_STATUS_BAD_TENSOR_STRIDES
Loading