已关闭
[Doc]: 【易用性专项-资料】【MindStudio】【文档正确性】首页、安装指南以及快速入门存在11个正确性问题要优化 #8
mominhua创建于  4月28日关闭于  5月22日
mominhua成员
4月28日 创建

在提交新问题之前,请确保您已经在社区中搜索过相关问题,并使用了社区中提供的资源/工具后,仍未找到满意的解决方式。

📚 文档问题描述

https://gitcode.com/Ascend/mskpp/blob/master/README.md
1、按照之前的开源资料模板,目录结构应该是先安装再快速入门吧?

https://gitcode.com/Ascend/mskpp/blob/master/docs/zh/install_guide/mskpp_install_guide.md
2、安装指南中缺少git clone代码仓的操作,导致安装操作流程被阻塞
3、requirements.txt文件名拼写错误导致无法执行
4、前后描述矛盾,描述写的是run包安装,实际是用的whl包安装,而且这里如果是用的whl包安装,那还算是集成在cann里面的吗?前文的描述以及cann安装是否符合实际情况?
5、whl安装并不需要赋予可执行权限,可以直接通过pip进行安装,这里的步骤多余且易引起误解
6、句子成分缺失。原文“在激活CANN环境,即可...”缺少时间状语标记“后”,导致介词结构不完整,语句不通顺。建议补充“后”字以符合语法规范。
7、路径有误,导致执行报错
8、命令参数错误:pip uninstall 命令应使用包名而非 .whl 文件名。传入文件名会导致 pip 无法识别并报错,导致卸载流程中断。
9、强制安装并不会有要输入y的提示,这里描述不正确

https://gitcode.com/Ascend/mskpp/blob/master/docs/zh/quick_start/mskpp_quick_start.md
10、存在多余空行
11、生成的结果目录和实际生成的不完全一致,缺少 instruction_cycle_consumption.html文件

建议的替代/修复方案

根据问题描述修改即可

欢迎加入社区,感谢您对社区的贡献 🎉!

likedislike
Mmominhua成员
4月28日 关联了里程碑:MindStudio 26.1.0
Mmominhua成员
4月28日 添加了label:high-prioritydocument
went_code
went_code成员
4月28日 评论:

👋 您好,欢迎向 MindStudio-Kernel-Performance-Prediction 提交 Issue!
我们已收到您的反馈,感谢你对开源社区的支持。🎉

📅 处理时效 维护团队将在工作日 24 小时内查看并回复您的问题。
🔍 自助排查(推荐优先查看) 在等待回复期间,您可以先查阅以下资源,多数问题可快速解决:

💡 **为了更快定位问题,请您确保 Issue 包含:

  1. 清晰的问题描述
  2. 可复现的操作步骤
  3. 相关日志、截图或环境信息

我们会尽快跟进,感谢您的理解与配合!

likedislike
luyq11luyq11成员
5月9日 关联了pull request:【doc】资料易用性更新
luyq11luyq11成员
5月9日 关联了pull request:【doc】资料易用性更新
luyq11luyq11成员
5月9日 删除了关联的pull request:【doc】资料易用性更新
luyq11luyq11成员
5月13日 关联了pull request:【doc】资料易用性更新
luyq11luyq11成员
5月14日 关联了pull request:【doc】资料易用性更新
孟广欣孟广欣成员
5月20日 关联了pull request:[doc]:优化资料中soc类型的获取方式
孟广欣孟广欣成员
5月20日 关联了pull request:[doc]:优化资料中soc类型的获取方式
Goldfish_of_SirisGoldfish_of_Siris成员
5月22日 添加了label:resolved
Goldfish_of_SirisGoldfish_of_Siris成员
5月22日 添加了label:pending
mominhua成员
5月22日 评论:

测试通过,问题已解决

1、问题已按照描述修改

likedislike
Mmominhua成员
5月22日 issue状态由 TODO 改变为 DONE
Mmominhua成员
5月22日 关闭了 issue
孟广欣孟广欣成员
7月17日 关联了pull request:[doc]:解决近期众测的问题