Closed
[Documentation|文档反馈]: Torch 扩展构建说明没有注明两种命令各自的执行目录 #7713
daishuangshuangAdd on  23 days agoClosed at  18 days ago
daishuangshuang
daishuangshuang
23 days ago Create

1)标题

Torch 扩展构建说明没有注明两种命令各自的执行目录

2)文档链接

torch_extension/README.md(第 19 行起)

3)问题文档片段

第 19—23 行:

#### 方式一:通过 build.sh 构建(推荐)

```sh
# 构建整包(包含所有算子)
bash build.sh --torch_extension

第 55—65 行:

#### 方式二:直接使用 python3 -m build 构建

```sh
# 安装依赖
python3 -m pip install -r requirements.txt

# 构建整包
python3 -m build --wheel -n

# 构建单算子包
TORCH_EXTENSION_OPS=swiglu_group TORCH_EXTENSION_VENDOR=custom python3 -m build --wheel -n

4)存在的问题(选填)

方式一的 build.sh 位于仓库根目录,方式二所需的打包配置则位于 torch_extension 目录。文档没有提醒读者在两种方式之间切换目录,因此无法在同一个工作目录下直接照抄全部命令。

如果沿用方式一的仓库根目录执行 python3 -m build --wheel -n,该目录没有 setup.py 或 pyproject.toml;如果一开始就在 torch_extension 目录,方式一又找不到那里的 build.sh。

建议明确写出:方式一从仓库根目录执行;方式二先执行 cd torch_extension,再安装依赖和打包,并说明相应的产物目录。可对照根目录构建脚本和扩展打包配置核实。

likedislike
yuning_chenyuning_chenCollaborators
23 days ago Assign chenqi317 as responsible person
yuning_chen
yuning_chenCollaborators
23 days ago Comments:

初步分析

感谢反馈。

现象理解:Torch 扩展构建说明未标明方式一(仓库根 build.sh)与方式二(torch_extension 下 python -m build)各自的工作目录。
当前判断:初步判断,待复现确认。两套命令依赖不同目录,照抄易在错误 cwd 下找不到脚本或 setup 配置。
涉及范围:torch_extension/README.md 构建章节。
下一步:补充各方式的执行目录与产物路径说明。

likedislike
yuning_chen
yuning_chenCollaborators
23 days ago Comments:

您好,该问题已收到,当前问题 @chenqi317 正在处理中

likedislike
daishuangshuangdaishuangshuang
22 days ago changed custom category from 任务 to 缺陷
yuning_chenyuning_chenCollaborators
22 days ago Assign fanqirui as responsible person, remove original responsible person: chenqi317
yuning_chen
yuning_chenCollaborators
22 days ago Comments:

您好,该问题已收到,当前问题 @fanqirui 正在处理中

likedislike
范其瑞范其瑞Collaborators
19 days ago Assign cong-jiyu as responsible person
范其瑞范其瑞Collaborators
19 days ago Removed responsible person fanqirui
丛吉钰丛吉钰Collaborators
18 days ago Associated pull request
丛吉钰丛吉钰Collaborators
18 days ago Deleted associated pull request: torch补充资料
丛吉钰丛吉钰Collaborators
18 days ago Associated pull request
丛吉钰丛吉钰Collaborators
18 days ago Deleted associated pull request: torch补充资料
丛吉钰丛吉钰Collaborators
18 days ago Associated pull request
CANN-robotCANN-robotCollaborators
18 days ago Close issue
CANN-robotCANN-robotCollaborators
18 days ago Added label: resolved
chenjiayi_
chenjiayi_Collaborators
10 days ago Comments:

补充说明本问题的修复结果:

结论:两种构建方式各自的执行目录与产物目录已写入 README,按文档顺序执行不再需要手动推测目录。

修复内容(文档):

  • torch_extension/README.md 方式一:新增「执行目录:仓库根目录(build.sh 位于根目录,产物输出到 build_out/)」。
  • 方式二:新增「执行目录:torch_extension/(打包配置 setup.py 位于该目录,仓库根目录下无法执行;产物输出到 torch_extension/dist/)」,并在命令块首行补 cd torch_extension。
  • 安装章节:区分两种产物路径,方式二用 dist/*.whl,方式一用 build_out/cann_ops_nn*.whl。
  • 目录结构树:build.sh 由 torch_extension/ 下移到仓库根目录,与实际位置一致。

验证:

  • 按修改后的文档逐条核对:方式一在仓库根目录执行、产物在 build_out/;方式二在 torch_extension/ 执行、产物在 torch_extension/dist/;安装命令路径与上述产物目录对应。

该 issue 已随修复合入关闭。

MR 链接:https://gitcode.com/cann/ops-nn/merge_requests/13464

likedislike
daishuangshuangdaishuangshuang
4 days ago changed custom state from 待办的 to 已完成