存储库结构

相关源文件

• .github/ISSUE_TEMPLATE/bug_report.md
• .github/ISSUE_TEMPLATE/feature_request.md
• .github/workflows/lock.yml
• .github/workflows/stale.yml
• .github/workflows/welcome-issue.yml
• .github/workflows/welcome-pr.yml
• .gitignore
• 00-course-setup/README.md
• 01-introduction-to-genai/README.md
• 02-exploring-and-comparing-different-llms/README.md
• 06-text-generation-apps/README.md
• 07-building-chat-applications/README.md
• 08-building-search-applications/README.md
• 09-building-image-applications/README.md
• 10-building-low-code-ai-applications/README.md
• 11-integrating-with-function-calling/README.md
• 12-designing-ux-for-ai-applications/README.md
• LICENSE
• README.md

本文档提供了“初学者生成式 AI”GitHub 存储库的结构、组织和关键组件的技术概述。它解释了代码库的组织方式、不同组件之间的关系以及存储库如何支持学习者和贡献者。

存储库概览

“初学者生成式 AI”存储库是一个全面的教育资源，包含 21 节课程，教授构建生成式 AI 应用的基础知识。该存储库的结构旨在提供从基本概念到高级实现的渐进式学习路径。

来源：README.md1-117 00-course-setup/README.md1-214

课程结构

存储库中的每个课程都遵循一致的结构，包括课程内容、代码示例和支持文件。

来源：README.md1-117 01-introduction-to-genai/README.md1-137

课程组成部分

每节课通常包括以下组成部分：

组件	描述	文件模式
课程内容	主要教育材料，包含解释和理论	README.md
图像	支持性的视觉效果、图表、屏幕截图	images/*.png, images/*.jpg
Python 示例	Python 代码示例	python/*.py, python/*.ipynb
TypeScript 示例	TypeScript 代码示例	typescript/*.ts, typescript/*.js
翻译	内容的本地化版本	translations/*/README.md

这些课程旨在提供一致的学习体验，包含理论内容和实践代码示例。

来源：README.md60-67 00-course-setup/README.md1-214

代码组织

存储库中的代码示例按语言组织，并遵循跨课程的一致模式。每个包含代码示例的课程都有用于 Python 和 TypeScript 实现的独立目录。

命名约定

代码库使用以下文件名约定：

前缀	描述
aoai-	使用 Azure OpenAI 服务的示例
oai-	使用 OpenAI API 的示例
githubmodels-	使用 GitHub Marketplace Model Catalog 的示例

这种一致的命名使学习者能够轻松识别代码示例正在使用的 API 或服务。

来源：README.md31-35 06-text-generation-apps/README.md75-86

开发环境

该存储库提供了多种设置开发环境的选项，包括 GitHub Codespaces、Python 本地开发和容器。

环境设置文件

该存储库包含几个用于设置开发环境的文件：

文件	目的
.devcontainer/	GitHub Codespaces 和本地容器开发的配置
requirements.txt	Python 依赖项
.env （不在存储库中）	API 密钥和端点的环境变量

来源：00-course-setup/README.md15-146

GitHub 工作流

该存储库使用 GitHub Actions 来自动化与存储库管理和社区参与相关的各种流程。

工作流功能

工作流	目的	触发器
welcome-pr.yml	添加标签和评论以欢迎新贡献者	新的拉取请求
welcome-issue.yml	添加标签和评论以欢迎新的 issue 创建者	新的 issue
stale.yml	标记并关闭过期的 issue 和 PR	计划执行（每日）
lock.yml	锁定已关闭的 issue	Issue 已关闭

来源：.github/workflows/welcome-pr.yml1-35 .github/workflows/welcome-issue.yml1-35 .github/workflows/stale.yml1-31 .github/workflows/lock.yml1-18

翻译系统

该存储库通过翻译系统支持多种语言，每节课程都有本地化内容。

翻译通过社区贡献进行维护，并强制执行以下流程：

1. 贡献者通过拉取请求提交翻译。
2. 不允许使用机器翻译（如00-course-setup/README.md205所述）
3. 翻译将由精通目标语言的社区成员进行验证。

来源：00-course-setup/README.md198-208 README.md1-117

文件结构概述

该存储库遵循一致的组织模式，具有以下顶级目录：

目录/文件	目的
00-course-setup/	设置开发环境的说明
01-introduction-to-genai/ 至 21-meta/	课程内容目录
.github/	GitHub 工作流和 issue 模板
.devcontainer/	开发容器配置
README.md	主存储库文档
LICENSE	MIT 许可证文件
.gitignore	Git 忽略配置
requirements.txt	Python 依赖项

每个课程目录包含：

1. 一个包含主要课程内容的 README.md 文件
2. 一个用于视觉效果的 images/ 目录
3. 特定语言的代码示例，位于 python/ 和/或 typescript/ 目录中
4. 一个包含本地化内容的 translations/ 目录

来源：README.md1-117 .gitignore1-169 LICENSE1-22

结论

“初学者生成式 AI”存储库的结构是一个全面的教育资源，其清晰的组织支持：

1. 通过 21 节课程实现的渐进式学习路径
2. 多种编程语言示例（Python 和 TypeScript）
3. 通过翻译实现国际化可访问性
4. 轻松设置开发环境
5. 通过自动化工作流实现积极的社区参与

这种结构使学习者能够有效地浏览内容，并专注于学习生成式 AI 概念和实现技术。