已合并
新增RadixTopK README #3197
huang-wei-chen创建于 6月9日
新增RadixTopK README #3197
已合并
huang-wei-chen创建于 6月9日
1 个文件变更+100-0
Amath/radix_top_k/README.md+100-0
@@ -0,0 +1,100 @@
1+# RadixTopK
2+ 
3+## 产品支持情况
4+ 
5+| 产品 | 是否支持 |
6+| ---- | :----:|
7+| <term>Ascend 950PR/Ascend 950DT</term> | × |
8+| <term>Atlas A3 训练系列产品/Atlas A3 推理系列产品</term> | √ |
9+| <term>Atlas A2 训练系列产品/Atlas A2 推理系列产品</term> | √ |
10+| <term>Atlas 200I/500 A2 推理产品</term> | × |
11+| <term>Atlas 推理系列产品</term> | × |
12+| <term>Atlas 训练系列产品</term> | × |
13+ 
14+## 功能说明
15+ 
16+- 接口功能:返回输入Tensor在指定维度上的k个极值及索引。RadixTopK算子支持通过输入Tensor指定k值。
17+ 
18+- 计算说明:
19+ - 当largest=True时,返回指定维度上最大的k个值及其索引
20+ - 当largest=False时,返回指定维度上最小的k个值及其索引
21+ 
22+## 参数说明
23+ 
24+<table style="undefined;table-layout: fixed; width: 980px"><colgroup>
25+ <col style="width: 100px">
26+ <col style="width: 150px">
27+ <col style="width: 280px">
28+ <col style="width: 330px">
29+ <col style="width: 120px">
30+ </colgroup>
31+ <thead>
32+ <tr>
33+ <th>参数名</th>
34+ <th>输入/输出/属性</th>
35+ <th>描述</th>
36+ <th>数据类型</th>
37+ <th>数据格式</th>
38+ </tr></thead>
39+ <tbody>
40+ <tr>
41+ <td>x</td>
42+ <td>输入</td>
43+ <td>待进行TopK计算的输入张量,支持1-8维度。</td>
44+ <td>FLOAT16、BFLOAT16</td>
45+ <td>ND</td>
46+ </tr>
47+ <tr>
48+ <td>k</td>
49+ <td>输入</td>
50+ <td>0D标量Tensor,表示计算维度上输出的极值个数。取值范围为[0, x.size(dim)]。</td>
51+ <td>INT32、INT64</td>
52+ <td>ND</td>
53+ </tr>
54+ <tr>
55+ <td>values</td>
56+ <td>输出</td>
57+ <td>TopK计算的输出值,数据类型与x保持一致。shape排序轴与k一致,非排序轴与x一致。</td>
58+ <td>FLOAT16、BFLOAT16</td>
59+ <td>ND</td>
60+ </tr>
61+ <tr>
62+ <td>indices</td>
63+ <td>输出</td>
64+ <td>TopK计算的输出索引,数据类型由indices_dtype属性指定。shape排序轴与k一致,非排序轴与x一致。</td>
65+ <td>INT32、INT64</td>
66+ <td>ND</td>
67+ </tr>
68+ <tr>
69+ <td>sorted</td>
70+ <td>属性</td>
71+ <td>可选布尔型,默认为True。True表示输出结果排序,False表示输出结果不排序。</td>
72+ <td>Bool</td>
73+ <td>-</td>
74+ </tr>
75+ <tr>
76+ <td>dim</td>
77+ <td>属性</td>
78+ <td>可选整型,默认为-1。表示计算维度。取值范围为[-x.dim(), x.dim())。</td>
79+ <td>Int</td>
80+ <td>-</td>
81+ </tr>
82+ <tr>
83+ <td>largest</td>
84+ <td>属性</td>
85+ <td>可选布尔型,默认为True。True表示返回最大的k个元素,False表示返回最小的k个元素。</td>
86+ <td>Bool</td>
87+ <td>-</td>
88+ </tr>
89+ <tr>
90+ <td>indices_dtype</td>
91+ <td>属性</td>
92+ <td>可选整型,默认为DT_INT32(3)。表示输出indices的数据类型,支持DT_INT32(3)或DT_INT64(9)。</td>
93+ <td>Int</td>
94+ <td>-</td>
95+ </tr>
96+ </tbody></table>
97+ 
98+## 约束说明
99+ 
100+