已合并
docs: optimize devcontainer configuration and documentation #1567
zhugexun_sjtu创建于 4月13日
docs: optimize devcontainer configuration and documentation #1567
已合并
zhugexun_sjtu创建于 4月13日
zhugexun_sjtu
zhugexun_sjtu成员
4月13日

描述

对 .devcontainer 进行了整体优化,主要包含三个方面:

1. devcontainer.json — 最小权限重构

旧配置使用 --privileged + ASCEND_VISIBLE_DEVICES=all 暴露 NPU 设备,权限过宽。新配置改为显式列出所需设备节点,去除不必要的宿主机命名空间共享:

  • 移除:--runtime=runc、--privileged、--net=host、--pid=host、--ipc=host、--cap-add=SYS_PTRACE
  • 移除:ASCEND_VISIBLE_DEVICES 环境变量、add-ons 挂载、/var/log/npu、/usr/slog 挂载
  • 新增:显式列出 /dev/davinci0–/dev/davinci7 及三个控制设备节点

2. README.md — 面向两类用户重组文档结构

参考 larksuite/cli 风格,将 Quick Start 按使用者类型拆分:

  • Quick Start (Human Users):VS Code Dev Containers 交互式流程,分 With NPU / Without NPU 两种情况
  • Quick Start (AI Agent):面向 Claude Code 等 AI Agent,给出完整 docker run 命令;要求 Agent 启动前与用户确认挂载参数并展示命令
  • Prerequisites 表格按 With/Without NPU 两列说明前置要求
  • Configuration 小节整合镜像源配置、数据目录、NPU 设备选择

3. Dockerfile — 自动 source 驱动环境变量

在 .zshrc 中追加条件判断:若 /usr/local/Ascend/driver/bin/setenv.bash 存在则自动 source,无驱动挂载时静默跳过。

关联的Issue

无

测试

  • 验证 devcontainer.json 在 VS Code Dev Containers 中可正常启动
  • 验证 docker run 命令在有/无 NPU 环境下均可执行
  • 验证各镜像源(APT / Conda / PyPI)均可访问(HTTP 200)

文档更新

更新了 .devcontainer/README.md,重组了文档结构,区分 Human Users 和 AI Agent 两种使用场景。

类型标签

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 zhugexun_sjtu 的贡献)
zhugexun_sjtuzhugexun_sjtu成员
4月13日 创建了 pull request,commit abb90d94
CANN-robot
CANN-robot成员
4月13日 评论:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here。
You can get sig-info at here


PR Approval Progress

✅ Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
repo-cann/asc-devkit ✅ sjtulxh, XuebinYang (2/2) ✅ sjtulxh (1/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

xun_zhuge, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robotCANN-robot成员
4月13日 添加了label:cann-cla/yes
此处折叠了9条事件消息 查看更多
zhugexun_sjtuzhugexun_sjtu成员
4月13日 修改了pull request 的描述
zhugexun_sjtu
zhugexun_sjtu成员
4月13日 评论:

compile

likedislike
CANN-robotCANN-robot成员
4月13日 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
4月13日 评论:

流水线任务触发成功
任务链接 [9338efbea14648a2a19615dc3fd98c46][流水线指导]

任务名称状态日志下载链接
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
SCA ✅ SUCCESS >>>>>
anti_virus ✅ SUCCESS >>>>>
codecheck ✅ SUCCESS
Check_Pr ✅ SUCCESS >>>>>
pre_comment ✅ SUCCESS >>>>>
Compile_Ascend_X86_ubuntu24 ✅ SUCCESS >>>>>
StaticCheck_codespell_check ⚠️ WARNING >>>>>
StaticCheck_link_validity_check ⚠️ WARNING >>>>>
StaticCheck_resource_existence_check ✅ SUCCESS
StaticCheck_tag_closed_check ✅ SUCCESS
StaticCheck_markdownlint ✅ SUCCESS
codecheck_codestyle ✅ SUCCESS >>>>>
UT_Test_3 ✅ SUCCESS
UT_Test_2 ✅ SUCCESS
UT_Test_1 ✅ SUCCESS
UT_Test ✅ SUCCESS
API_Check ✅ SUCCESS >>>>>
UT_Test_report ✅ SUCCESS >>>>>

[2026-04-13 17:08:04]    CI执行结束

likedislike
sjtulxh成员
4月13日 评论:

/approve

likedislike
CANN-robotCANN-robot成员
4月13日 添加了label:approved
XuebinYang成员
4月13日 评论:

/lgtm

likedislike
CANN-robotCANN-robot成员
4月13日 添加了label:lgtm
CANN-robotCANN-robot成员
4月13日 添加了label:api-check-pass
CANN-robotCANN-robot成员
4月13日 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
4月13日 添加了label:ci-pipeline-passed
CANN-robot
CANN-robot成员
4月13日 评论:

Review Guide

This pull-request passes review.
Committers who wrote a comment of /approve are: sjtulxh.
Reviewers who wrote a comment of /lgtm are: sjtulxh, XuebinYang.

likedislike
CANN-robotCANN-robot成员
4月13日 合入了pull request