ARTICLE DETAIL

资讯详情

深耕网站建设与运营推广的一线实战洞察。

AGENTS.md 详解:ML-For-Beginners 课程仓库的目录结构、环境搭建与开发协作全流程

AGENTS.md 详解:ML-For-Beginners 课程仓库的目录结构、环境搭建与开发协作全流程 AGENTS.md 详解ML-For-Beginners 课程仓库的目录结构、环境搭建与开发协作全流程【免费下载链接】ML-For-Beginners12 weeks, 26 lessons, 52 quizzes, classic Machine Learning for all项目地址: https://gitcode.com/GitHub_Trending/ml/ML-For-BeginnersAGENTS.md 是 ML-For-Beginners12 周、26 课、52 次测验的经典机器学习课程仓库面向开发者与 AI Agent 编写的工程指南集中描述了仓库结构、Python/R/Jupyter/Vue.js 四类环境的安装命令、文档站点与 PDF 构建方式、测验应用开发与部署流程、自动化翻译机制以及贡献规范。读完本文你可以独立完成课程笔记的本地运行、Docsify 文档站与 pdf/readme.pdf 的生成、quiz-app 的调试与构建并清楚哪些文件属于自动生成、不应手工修改的边界。文档定位它说明了什么AGENTS.md 开宗明义本仓库是一个自定进度self-paced的学习资源围绕 Python以 Scikit-learn 为主与 R 双语言实现经典机器学习课程包含 26 课、动手项目、测验与作业各课案例取材自世界各地的真实数据。其关键组件归纳为五点教育内容26 课覆盖 ML 导论、回归、分类、聚类、NLP、时间序列与强化学习测验应用基于 Vue.js 的课前/课后测验应用多语言支持通过 GitHub Actions 自动生成 40 语言的翻译双语言课程PythonJupyter Notebook与 RR Markdown两个版本项目式学习每个主题配有实战项目与作业。文末的Key Technologies一节进一步固化了技术栈清单PythonScikit-learn、Pandas、NumPy、Matplotlib、Rtidyverse、tidymodels、caret、Jupyter、R Markdown、Vue.js 3、Flask用于模型部署课、Docsify文档站、GitHub ActionsCI/CD 与自动翻译。仓库目录结构与课程模块约定AGENTS.md 给出的顶层结构如下ML-For-Beginners/ ├── 1-Introduction/ # ML 基础、历史、公平性、技术方法 ├── 2-Regression/ # 回归模型Python/R ├── 3-Web-App/ # 用 Flask 部署 ML 模型的 Web 应用 ├── 4-Classification/ # 分类算法 ├── 5-Clustering/ # 聚类技术 ├── 6-NLP/ # 自然语言处理 ├── 7-TimeSeries/ # 时间序列预测 ├── 8-Reinforcement/ # 强化学习 ├── 9-Real-World/ # 真实世界 ML 应用 ├── quiz-app/ # Vue.js 测验应用 ├── translations/ # 自动生成的翻译 └── sketchnotes/ # 视觉化学习辅助每个课程文件夹遵循统一的内部约定文件/目录职责README.md课程正文内容notebook.ipynbPython Jupyter 笔记本solution/参考解答Python 与 R 版本assignment.md练习作业images/视觉素材从源码结构看这一约定与仓库实际情况高度吻合例如 2-Regression/1-Tools/solution 目录下包含notebook.ipynb以及R、Julia子目录对应 AGENTS.md 所述solution/R/中为.rmd或.ipynb文件的 R 课部分课程甚至额外提供了 Julia 版本。课程入口索引则由 docs/_sidebar.md 维护——该文件以../1-Introduction/1-intro-to-ML/README.md这样的相对路径串联起全部九大章节的 26 篇课程 README也是 Docsify 侧边栏与 PDF 生成的目录骨架。环境搭建四类运行环境的安装命令Python 课程Jupyter ML 常用库# 确认 Python 3.8 python --version # 安装 Jupyter pip install jupyter # 安装常用 ML 库 pip install scikit-learn pandas numpy matplotlib seaborn # 特定课程按需在课程内补充依赖 # 示例Web App 课程 pip install flask补充一点仓库佐证仓库提供了.devcontainer/Dockerfile基于mcr.microsoft.com/vscode/devcontainers/python镜像默认3.10-bullseye变体可选 Node.js 版本配合.devcontainer/devcontainer.json预装ms-python.python、ms-python.vscode-pylance扩展并配置了 pylint、black、autopep8、bandit、flake8、mypy 等工具路径。用 VS Code Dev Container 打开仓库即可直接获得一套与文档风格指南一致的开发环境。R 课程R 课以.rmdR Markdown或.ipynbJupyter R kernel形式存放在各课的solution/R/子目录中核心依赖# 在 R 控制台中 install.packages(c(tidyverse, tidymodels, caret))测验应用Vue.jscd quiz-app npm install从 quiz-app/package.json 可确认其技术选型vue^3.5.12、vue-i18n^8.26.7、vue-router^3.5.3构建链为vue/cli-service~5.0.8与 AGENTS.md 中Vue.js 3的描述一致。源码组织为src/下的 App.vue、main.js、components/、router/、views/与assets/。文档站点Docsify# 安装 Docsify npm install -g docsify-cli # 从仓库根目录启动 docsify serve # 访问 http://localhost:3000Docsify 属于无构建步骤的静态文档方案入口是仓库根目录的 index.html其中通过window.$docsify { name: Machine Learning for Beginners, repo: ..., relativePath: true, auto2top: true }配置站点名称与相对路径解析并引用 CDN 上的 docsify-themeable 主题样式。日常开发工作流课程笔记本的标准流程进入课程目录如2-Regression/1-Tools/打开 Jupyter 笔记本jupyter notebook notebook.ipynb按课程内容与练习逐步执行需要时查看solution/文件夹中的解答。Python 与 R 开发要点Python 课使用标准数据科学库以 Jupyter 交互方式进行解答位于每课的solution/R 课为.rmd格式解答位于solution/R/子目录使用 RStudio 或带 R kernel 的 Jupyter 运行。测验应用开发cd quiz-app # 启动开发服务器http://localhost:8080 npm run serve # 生产构建 npm run build # Lint 并自动修复 npm run lint三个脚本在 quiz-app/package.json 中分别映射为vue-cli-service serve、vue-cli-service build、vue-cli-service lintESLint 规则配置内嵌于该文件的eslintConfig字段plugin:vue/essentialeslint:recommended解析器为babel-eslint这与 AGENTS.mdESLint 配置在 quiz-app/package.json 中的说法互相印证。测试与验证策略为什么没有自动化测试AGENTS.md 明确指出本仓库本质是教育课程仓库课程正文没有自动化测试。验证手段分两条线课程内容完成课程练习、确保笔记本各 cell 成功运行、将输出与solution/中的预期结果比对quiz-appnpm run lint检查代码、npm run build验证无编译错误。cd quiz-app npm run lint npm run build代码风格指南Python遵循 PEP 8变量命名清晰、自解释复杂操作加注释Jupyter 笔记本中应保留解释概念的 Markdown cell仓库中课程笔记本的普遍形态即代码 cell 与说明 cell 交替JavaScript/Vue.js遵循 Vue.js 风格指南ESLint 配置见 quiz-app/package.json通过npm run lint检查并自动修复文档Markdown结构清晰代码放入围栏代码块内部引用使用相对链接沿用既有排版约定。构建与部署测验应用上 Azure文档出 PDFquiz-app 部署到 Azure Static Web AppsAGENTS.md 给出的部署流程与 quiz-app/README.md 中的详细指南一致前置条件Azure 账号 已 Fork 的 GitHub 仓库创建 Azure Static Web App在 Azure 门户创建资源连接 GitHub 仓库关键构建参数为App Location/quiz-appOutput LocationdistAzure 会自动生成 GitHub Actions 工作流工作流文件自动生成在.github/workflows/azure-static-web-apps-*.yml在推送至 main 分支时自动构建部署。quiz-app/README.md 中还附带了一份工作流示例Azure/static-web-apps-deployv1actionapp_location: /quiz-app、output_location: dist可作为自建部署时的参照。文档 PDF 生成npm install npm run convert该命令对应根 package.json 中的脚本convert: node_modules/.bin/docsify-to-pdf依赖docsify-to-pdf0.0.5。具体行为由 docsifytopdf.js 决定关键配置module.exports { contents: [docs/_sidebar.md], // 目录文件 pathToPublic: pdf/readme.pdf, // PDF 输出路径 pdfOptions: { margin: { top: 100px, bottom: 100px } }, removeTemp: true, // 清理生成的临时 .md/.html emulateMedia: print, // 以打印媒体类型渲染 };也就是说PDF 以docs/_sidebar.md为目录骨架抓取全部课程页面产物落在仓库中的 pdf/readme.pdf。翻译工作流只读生成物禁止手工翻译AGENTS.md 对翻译的表述非常强调翻译由 GitHub Actions 调用 Co-op Translator自动生成推送main分支后触发不要手工翻译内容也不得修改已生成的翻译文件工作流定义于.github/workflows/co-op-translator.yml使用 Azure AI/OpenAI 服务支持 40 语言。从当前仓库快照可以观察到翻译的实际产出规模translations/目录下已有55 个语言子目录每个语言目录包含 99 个.md与 51 个.ipynb约 150 个文件即每门课程的 README 与笔记本都被翻译覆盖配套的translated_images/目录同样按语言分目录存放图片的 WebP 版本。值得说明的是当前快照的.github/workflows/目录中可见的是lock.yml、stale.yml与 SLSA 生成器工作流未见co-op-translator.yml本体——可以推断翻译工作流由上游平台侧管理或随分支策略下发但翻译产物本身是稳定存在的仓库内容。另外 CONTRIBUTING.md 补充了一条人文要求若由社区志愿者翻译不得使用机器翻译需在自己熟练的语言中提供。贡献规范与 Pull Request 约定内容贡献者的六步流程Fork 仓库并创建特性分支如需新增/更新课程修改课程正文不要修改自动生成的翻译文件测试代码确保所有 notebook cell 可成功运行验证链接与图片有效提交带清晰描述的 Pull Request。PR 的硬性要求标题格式[Section] 简述改动如[Regression] Fix typo in lesson 5、[Quiz-App] Update dependencies提交前notebook 全部 cell 无错执行如改动 quiz-app 则运行npm run lint校验 Markdown 格式实测新代码示例PR 必须包含改动描述、改动理由、UI 改动截图如有行为准则遵循 CODE_OF_CONDUCT.mdMicrosoft Open Source Code of ConductCLA需签署 Contributor License Agreement由 CLA-bot 在 PR 上自动识别与提示。课程内容的七段式结构AGENTS.md 将每课的组织模式固化为七个环节这解释了为何每个课程目录中 README、notebook、assignment、quiz 资源并存Pre-lecture quiz——测基础摸底Lesson content——书面讲解Code demonstrations——笔记本中的动手示例Knowledge checks——过程中持续验证理解Challenge——独立应用概念Assignment——扩展练习对应assignment.mdPost-lecture quiz——课后测验评估学习成果。课前/课后测验即由 quiz-app 承载这也是26 课、52 测验课前课后各一次这一数字的由来。常用命令速查AGENTS.md 最后汇总了一张覆盖全工作流的命令表# Python/Jupyter jupyter notebook # 启动 Jupyter 服务器 jupyter notebook notebook.ipynb # 打开指定笔记本 pip install -r requirements.txt # 安装依赖如课程提供 # Quiz App cd quiz-app npm install # 安装依赖 npm run serve # 开发服务器 npm run build # 生产构建 npm run lint # Lint 并修复 # Documentation docsify serve # 本地文档站点 npm run convert # 生成 PDF # Git 工作流 git checkout -b feature/my-change # 创建特性分支 git add . # 暂存 git commit -m Description # 提交 git push origin feature/my-change # 推送到远端安全注意事项与故障排查安全要点代码中绝不提交密钥与凭据保持 npm 与 pip 依赖更新Flask 示例 Web App 包含基础的用户输入校验示例数据集均为公开、非敏感数据。故障排查Jupyter 笔记本kernel 卡死Kernel → RestartImportError用 pip 装齐所需包路径问题在笔记本所在目录内运行。Quiz 应用npm install失败npm cache clean --force端口冲突npm run serve -- --port 8081构建错误删除node_modules后重装rm -rf node_modules npm install。R 课程找不到包install.packages(package-name)R Markdown 渲染确认安装了 rmarkdown 包Jupyter 中 R kernel 异常可能需安装 IRkernel。仓库另配有更深入的 TROUBLESHOOTING.md 文档可作扩展排查参考。项目性质备注先理解概念再谈工程优化AGENTS.md 以Project-Specific Notes收尾划定了对代码与文档的预期边界这是学习课程不是生产代码重点是通过动手实践理解 ML 概念代码示例清晰优先于优化大多数课程自包含可独立完成提供解答但学习者应先自行尝试使用Docsify构建无构建步骤的 Web 文档Sketchnotes见 sketchnotes/提供概念的视觉化摘要多语言支持让内容面向全球可访问。综合来看AGENTS.md 的价值不仅在于罗列命令而在于它把课程仓库这一特殊形态的工程约定——自动生成物与人工内容的边界、七段式课程结构、双语言解答目录、测验应用与文档站的独立构建链——集中成了一份可被人与 AI Agent 共同执行的契约是理解并贡献该仓库的最佳入口。【免费下载链接】ML-For-Beginners12 weeks, 26 lessons, 52 quizzes, classic Machine Learning for all项目地址: https://gitcode.com/GitHub_Trending/ml/ML-For-Beginners创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表