Closed
[Documentation|文档反馈]: [MhcSinkhorn] README 将批量固定迭代接口描述成二维矩阵、Tensor 迭代参数及自适应早停 #6899
daishuangshuangAdd on 11 days agoClosed at 9 days ago
周云飞
11 days ago Comments:
11 days ago Comments:
感谢您详细列出文档差异,并明确区分源码中的错误字符串与实际运行日志。此问题的重点是让 README 准确描述现有接口,而不是扩展二维输入、迭代上限或早停能力。
问题分析
按您提供的接口定义和实现位置,README 中需要重点对齐以下内容:
- 输入与属性:区分输入张量
h_res和属性eps、num_iters、out_flag,避免将迭代次数与稳定计算参数描述为张量输入。 - 形状与范围:说明 3D/4D 批量输入的维度含义、矩阵阶数
N为 4、6、8,以及num_iters为 1~100 的约束。按报告中的检查逻辑,二维[4,4]和num_iters=150分别不满足维度与迭代次数要求。 - 计算语义:区分用于数值稳定的
eps与收敛阈值,避免把固定次数迭代写成自适应早停。您指出的 Exp/Softmax 预处理也直接影响参考结果,不能仅用“对非负矩阵反复归一化”代替实际计算过程。
这些差异会影响用户构造输入和参考实现。具体接口约束与计算顺序仍需结合对应实现完整确认;目前没有目标设备上的调用结果。
处理方向
一个可行的调整方向是同步修订参数表、形状约束、算法说明和示例,并补充 out_flag 各取值对应的输出含义。示例可采用您建议的 h_res 形状 [1,4,4]、num_iters=20、eps=1e-6,同时明确 out_flag 及其余适用条件;参考实现则需与预处理、归一化顺序和稳定项的使用位置保持一致。
当前应聚焦文档与实现的一致性,不将支持二维输入、超过 100 次迭代或增加早停混入本次文档修正范围。


fengjiawei1
11 days ago Comments:
11 days ago Comments:
/assign


11 days ago Assign fengjiawei1 as responsible person
10 days ago Associated pull request
10 days ago changed custom category from 任务 to 缺陷
9 days ago Close issue
9 days ago Added label: resolved
1)标题
[Doc Bug][MhcSinkhorn] README 将批量固定迭代接口描述成二维矩阵、Tensor 迭代参数及自适应早停
2)问题描述
MhcSinkhorn README第 49~67、81~82 行与实际定义存在多处直接冲突:
依据:OpDef第 23、47~49 行;Host Tiling第 84~88、161~183 行;arch35 Kernel第 222~233、504 行附近。Kernel 还会先做 Exp/Softmax,README 对输入和迭代过程的说明不足以构造一致的参考实现。
3)环境信息
4)重现步骤
[4,4],迭代次数取 50,eps=1e-6。使用实际接口映射到 h_res、num_iters、eps 后调用。[1,4,4]、out_flag=0,但按 README 推荐取num_iters=150。5)预期结果
README 应描述真实接口名称、属性类型、批量 shape、N 范围和 1~100 次迭代约束,明确 eps 的稳定计算作用及实际输出含义。用户按照文档构造的基础用例应能通过参数校验。
6)日志截图等
源码中的错误字符串,未冒充本次运行日志:
对应 Host Tiling 第 163~164、86~87、182~183 行。
7)备注
应修正文档,不将“支持二维输入、200 次迭代、增加早停”混写成缺陷修复要求。建议文档示例使用
h_res=[1,4,4]、num_iters=20、eps=1e-6,并与实际算法的 golden 一起校对。