Skip to content

[feature]支持peft的quick start文档测试看护 - #142

Merged
hipudding merged 1 commit into
Ascend:mainfrom
Devin-DC-Huang:main
Sep 4, 2026
Merged

[feature]支持peft的quick start文档测试看护#142
hipudding merged 1 commit into
Ascend:mainfrom
Devin-DC-Huang:main

Conversation

@Devin-DC-Huang

Copy link
Copy Markdown
Contributor

No description provided.

@ascend-robot

Copy link
Copy Markdown

CLA Signature Guide

@Devin-DC-Huang , thanks for your pull request.

The following commit(s) are not associated with a signed Contributor License Agreement (CLA).

Commit Reason
[3e5842d [feature]支持peft的quick sta...](3e5842d) the email used in the commit is an invalid email!
please check all commits.

To sign CLA, click here.

To check if your email is configured correctly, refer to the FAQs.

Once you've signed the CLA or updating your email, please comment /check-cla to revalidate CLA status.

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

📖 文档预览已随本 PR 关闭而清理。

github-actions Bot pushed a commit that referenced this pull request Sep 1, 2026
@ascend-robot

Copy link
Copy Markdown

CLA Signature Guide

@Devin-DC-Huang , thanks for your pull request.

The following commit(s) are not associated with a signed Contributor License Agreement (CLA).

Commit Reason
[3e5842d [feature]支持peft的quick sta...](3e5842d) the email used in the commit is an invalid email!
please check all commits.

To sign CLA, click here.

To check if your email is configured correctly, refer to the FAQs.

Once you've signed the CLA or updating your email, please comment /check-cla to revalidate CLA status.

@ascend-robot

Copy link
Copy Markdown

CLA Signature Guide

@Devin-DC-Huang , thanks for your pull request.

The following commit(s) are not associated with a signed Contributor License Agreement (CLA).

Commit Reason
[3e5842d [feature]支持peft的quick sta...](3e5842d) the email used in the commit is an invalid email!
please check all commits.

To sign CLA, click here.

To check if your email is configured correctly, refer to the FAQs.

Once you've signed the CLA or updating your email, please comment /check-cla to revalidate CLA status.

@ascend-robot

Copy link
Copy Markdown

CLA Signature Guide

@Devin-DC-Huang , thanks for your pull request.

The following commit(s) are not associated with a signed Contributor License Agreement (CLA).

Commit Reason
[aedf139 [feature]支持peft的quick sta...](aedf139) the email used in the commit is an invalid email!
please check all commits.

To sign CLA, click here.

To check if your email is configured correctly, refer to the FAQs.

Once you've signed the CLA or updating your email, please comment /check-cla to revalidate CLA status.

@ascend-robot

Copy link
Copy Markdown

CLA Signature Guide

@Devin-DC-Huang , thanks for your pull request.

The following commit(s) are not associated with a signed Contributor License Agreement (CLA).

Commit Reason
[2ee0a4e [feature]支持peft的quick sta...](2ee0a4e) the email used in the commit is an invalid email!
please check all commits.

To sign CLA, click here.

To check if your email is configured correctly, refer to the FAQs.

Once you've signed the CLA or updating your email, please comment /check-cla to revalidate CLA status.

@ascend-robot

Copy link
Copy Markdown

CLA Signature Guide

@Devin-DC-Huang , thanks for your pull request.

The following commit(s) are not associated with a signed Contributor License Agreement (CLA).

Commit Reason
[34eea25 [feature]支持peft的quick sta...](34eea25) the email used in the commit is an invalid email!
please check all commits.

To sign CLA, click here.

To check if your email is configured correctly, refer to the FAQs.

Once you've signed the CLA or updating your email, please comment /check-cla to revalidate CLA status.

@ascend-robot

Copy link
Copy Markdown

CLA Signature Guide

@Devin-DC-Huang , thanks for your pull request.

The following commit(s) are not associated with a signed Contributor License Agreement (CLA).

Commit Reason
[222a64a [feature]支持peft的quick sta...](222a64a) the email used in the commit is an invalid email!
please check all commits.

To sign CLA, click here.

To check if your email is configured correctly, refer to the FAQs.

Once you've signed the CLA or updating your email, please comment /check-cla to revalidate CLA status.

@ascend-robot

Copy link
Copy Markdown

CLA Signature Guide

@Devin-DC-Huang , thanks for your pull request.

The following commit(s) are not associated with a signed Contributor License Agreement (CLA).

Commit Reason
[b5dbf88 [feature]支持peft的quick sta...](b5dbf88) the email used in the commit is an invalid email!
please check all commits.

To sign CLA, click here.

To check if your email is configured correctly, refer to the FAQs.

Once you've signed the CLA or updating your email, please comment /check-cla to revalidate CLA status.

@ascend-robot

Copy link
Copy Markdown

CLA Signature Guide

@Devin-DC-Huang , thanks for your pull request.

The following commit(s) are not associated with a signed Contributor License Agreement (CLA).

Commit Reason
[172623c [feature]支持peft的quick sta...](172623c) the email used in the commit is an invalid email!
please check all commits.

To sign CLA, click here.

To check if your email is configured correctly, refer to the FAQs.

Once you've signed the CLA or updating your email, please comment /check-cla to revalidate CLA status.

@ascend-robot

Copy link
Copy Markdown

CLA Signature Guide

@Devin-DC-Huang , thanks for your pull request.

The following commit(s) are not associated with a signed Contributor License Agreement (CLA).

Commit Reason
[0878a34 [feature]支持peft的quick sta...](0878a34) the email used in the commit is an invalid email!
please check all commits.

To sign CLA, click here.

To check if your email is configured correctly, refer to the FAQs.

Once you've signed the CLA or updating your email, please comment /check-cla to revalidate CLA status.

@ascend-robot

Copy link
Copy Markdown

CLA Signature Guide

@Devin-DC-Huang , thanks for your pull request.

The following commit(s) are not associated with a signed Contributor License Agreement (CLA).

Commit Reason
[4a9ecc3 [feature]支持peft的quick sta...](4a9ecc3) the email used in the commit is an invalid email!
please check all commits.

To sign CLA, click here.

To check if your email is configured correctly, refer to the FAQs.

Once you've signed the CLA or updating your email, please comment /check-cla to revalidate CLA status.

@ascend-robot

Copy link
Copy Markdown

CLA Signature Guide

@Devin-DC-Huang , thanks for your pull request.

The following commit(s) are not associated with a signed Contributor License Agreement (CLA).

Commit Reason
[c01370d [feature]支持peft的quick sta...](c01370d) the email used in the commit is an invalid email!
please check all commits.

To sign CLA, click here.

To check if your email is configured correctly, refer to the FAQs.

Once you've signed the CLA or updating your email, please comment /check-cla to revalidate CLA status.

@ascend-robot

Copy link
Copy Markdown

CLA Signature Guide

@Devin-DC-Huang , thanks for your pull request.

The following commit(s) are not associated with a signed Contributor License Agreement (CLA).

Commit Reason
[051d014 [feature]支持peft的quick sta...](051d014) the email used in the commit is an invalid email!
please check all commits.

To sign CLA, click here.

To check if your email is configured correctly, refer to the FAQs.

Once you've signed the CLA or updating your email, please comment /check-cla to revalidate CLA status.

github-actions Bot pushed a commit that referenced this pull request Sep 3, 2026
@hipudding

Copy link
Copy Markdown
Collaborator
image 这里建议用Note高亮

@hipudding

Copy link
Copy Markdown
Collaborator
image 说明类的格式不统一,建议统一下,都用note是否合适

@ascend-robot

Copy link
Copy Markdown

CLA Signature Guide

@Devin-DC-Huang , thanks for your pull request.

The following commit(s) are not associated with a signed Contributor License Agreement (CLA).

Commit Reason
[051d014 [feature]支持peft的quick sta...](051d014) the email used in the commit is an invalid email!
please check all commits.

To sign CLA, click here.

To check if your email is configured correctly, refer to the FAQs.

Once you've signed the CLA or updating your email, please comment /check-cla to revalidate CLA status.

@Devin-DC-Huang Devin-DC-Huang changed the title [feature]支持peft的quick start文档测试看护(pr触发) [feature]支持peft的quick start文档测试看护 Sep 4, 2026
@ascend-robot

Copy link
Copy Markdown

CLA Signature Guide

@Devin-DC-Huang , thanks for your pull request.

The following commit(s) are not associated with a signed Contributor License Agreement (CLA).

Commit Reason
[221a3f9 [feature]支持peft的quick sta...](221a3f9) the email used in the commit is an invalid email!
please check all commits.

To sign CLA, click here.

To check if your email is configured correctly, refer to the FAQs.

Once you've signed the CLA or updating your email, please comment /check-cla to revalidate CLA status.

github-actions Bot pushed a commit that referenced this pull request Sep 4, 2026
把 peft quick start 文档接入 doc-test 看护流程: PR 触发 + 调度运行,
并把下载路径从 modelscope 切到 HuggingFace Hub 以满足 120 min
job timeout 预算。

CI 基础设施
- .github/workflows/peft-quick-start.yml: PR 触发 + 调度三小时一次
- .github/workflows/quick-start-template.yml: 共享执行引擎
  (peft 不再传 container_options,NFS 已持久化 /root/.cache,
   bind mount 在缺 CAP_SYS_ADMIN 的 burstable K8s pod 上是 no-op)
- job timeout 提到 120 min,DEFAULT_COMMAND_TIMEOUT 同步到 7200s

诊断探针 + 缓存校验(provider-split 架构)
- tests/doc_test/modelscope_cache.py → model_cache.py
- 按 provider 拆 modelscope / huggingface 两组函数
- HF 新增 resolve_huggingface_cache / report_huggingface_state /
  purge_huggingface_corrupt(HF 标准 layout:
  models--<org>--<model>/{blobs,snapshots})
- provider-agnostic 工具: ensure_safetensors /
  safetensors_header_ok / _curl_throughput_probe /
  diagnose_mount_environment(findmnt / stat / mountinfo / cgroup /
  CapBnd / df + modelscope.cn 与 huggingface.co 原始 endpoint 吞吐对比,
  辅助"是否切换 snapshot_download provider"决策)

切换到 HuggingFace Hub
- 决策依据: modelscope.cn 0.39 MiB/s(补 3.70 GB 缺失 shard 需 2.7h,
  已超 120 min job timeout);huggingface.co 16.71 MiB/s(42x 快);
  HF 缓存 /root/.cache/huggingface/hub/ 已暖好 5.75 GB 完整模型
- sources/peft/quick_start.md: 组件表 / pip install /
  snapshot 入口全部从 modelscope 切到 huggingface_hub
- tests/peft/test_quick_start_ascend.py: imports 与
  prepare_environment 调用方改用 report_huggingface_state /
  purge_huggingface_corrupt / resolve_huggingface_cache

代码精简 + quick_start.md 格式优化
- tests/doc_test/base.py / model_cache.py /
  test_quick_start_ascend.py: 删冗余注释
- sources/peft/quick_start.md:
  * 6 处 blockquote/list 改成 MyST admonition ` ```{admonition} Note`
    + `:class: note`(验证过只有 fenced 风格在 .md 里被识别,
    rST 的 `.. note::` 不渲染;通用 admonition 才能自定义 title)
  * npu-smi / torch_npu 恢复路径更醒目
  * xxx 占位符、<model_path> 含义都进入 note 框
  * L247 <model_path> 措辞改成新手可读(移除 apply-lora 块/jargon
    引用,直接说"是下载基础模型一节 snapshot_download 命令打印的路径")
  * 删除末尾"小贴士"一节
  * 末尾新增"外部链接"节(GitHub + PEFT Docs)

peft index 内联 quick_start
- sources/peft/index.rst → index.md(改用 MyST 才能用 {include})
- 新 content.md: 简介 + ` ```{include} quick_start.md`
  ` 一行嵌入,避免点两次才能看到 quick_start 内容
- 父 index.rst 的 toctree 引用相应改成 sources/peft/index.md
@ascend-robot

Copy link
Copy Markdown

CLA Signature Pass

Devin-DC-Huang, thanks for your pull request. All authors of the commits have signed the CLA. 👍

github-actions Bot pushed a commit that referenced this pull request Sep 4, 2026
github-actions Bot added a commit that referenced this pull request Sep 4, 2026
@Devin-DC-Huang Devin-DC-Huang reopened this Sep 4, 2026
@ascend-robot

Copy link
Copy Markdown

CLA Signature Pass

Devin-DC-Huang, thanks for your pull request. All authors of the commits have signed the CLA. 👍

@Devin-DC-Huang

Copy link
Copy Markdown
Contributor Author

image 这里建议用Note高亮

已修复

github-actions Bot pushed a commit that referenced this pull request Sep 4, 2026
@hipudding
hipudding merged commit b609d41 into Ascend:main Sep 4, 2026
11 checks passed
github-actions Bot added a commit that referenced this pull request Sep 4, 2026
licy666 added a commit to licy666/docs that referenced this pull request Sep 4, 2026
Keep llama.cpp's Sphinx exclude and tutorial landing page. Take main's
peft index.md, shared doc-test engine, and peft Quick Start.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants