开发环境

相关源文件

• .devcontainer/Setup.txt
• .devcontainer/devcontainer.json
• .devcontainer/icon.svg
• .devcontainer/post-create.sh
• 00-course-setup/translations/es-mx/README.md
• 00-course-setup/translations/ko/README.md
• 00-course-setup/translations/tw/README.md
• 01-introduction-to-genai/translations/ko/README.md
• 12-designing-ux-for-ai-applications/translations/ko/README.md
• docs/_sidebar.md
• package-lock.json
• package.json
• requirements.txt
• translations/tw/README.md
• vs.code-profile

本文档提供了有关设置和配置生成式AI初学者课程开发环境的详细信息。它涵盖了容器配置、必需的依赖项以及各种设置选项，以确保您可以有效地运行此存储库中的代码示例。

设置选项

本课程的开发环境有多种设置方法。推荐的方法是使用GitHub Codespaces，因为它提供了最一致且无忧的体验，但也提供了本地设置选项。

设置选项概述

来源： .devcontainer/devcontainer.json 00-course-setup/translations/es-mx/README.md 00-course-setup/translations/ko/README.md 00-course-setup/translations/tw/README.md

GitHub Codespaces（推荐）

开始本课程最简单的方法是使用GitHub Codespaces，它可在云端提供预配置的开发环境。

创建codespace

1. 将存储库fork到你的GitHub账户
2. 点击你fork上的“Code”按钮
3. 选择“Codespaces”选项卡
4. 点击“Create codespace on main”

codespace将根据.devcontainer目录中的配置自动设置所有必需的依赖项和扩展。

本地设置

要在你的计算机上本地运行代码

1. 确保已安装Python（任何最新版本）
2. 克隆仓库

   git clone https://github.com/microsoft/generative-ai-for-beginners
   cd generative-ai-for-beginners
   

3. 安装所需的依赖项

   pip install -r requirements.txt
   

可选：使用Miniconda

你可以使用Miniconda创建一个隔离的Python环境

1. 安装Miniconda
2. 创建环境文件 .devcontainer/environment.yml

3. 创建并激活环境

   conda env create --name ai4beg --file .devcontainer/environment.yml
   conda activate ai4beg
   

容器设置

对于熟悉容器的用户，可以使用存储库中提供的开发容器配置

1. 安装Docker
2. 安装带有Remote - Containers扩展的VS Code
3. 在 VS Code 中打开存储库
4. 出现提示时，选择“Reopen in Container”

这将构建一个包含所有必要依赖项和配置的容器。

来源： .devcontainer/devcontainer.json 00-course-setup/translations/es-mx/README.md27-101 00-course-setup/translations/ko/README.md28-98 00-course-setup/translations/tw/README.md27-106

依赖项和要求

该课程需要特定的Python和Node.js库来运行代码示例。这些依赖项通过Python的requirements.txt和Node.js的package.json进行管理。

依赖结构

来源： requirements.txt package.json package-lock.json

Python依赖项

需要以下Python库

库	版本	目的
ipywidgets	7.7.1	交互式Jupyter小部件
matplotlib	3.9.4	数据可视化
numpy	1.24.2	数值计算
pandas	1.5.3	数据操作
tqdm	4.67.1	进度条
python-dotenv	1.0.0	环境变量管理
openai	>=0.28.0	OpenAI API客户端
tiktoken	最新版	OpenAI模型的Tokenizer
azure-ai-inference	最新版	Azure AI服务客户端

Node.js依赖项

对于JavaScript/TypeScript示例，需要以下Node.js包

包	目的
@azure-rest/ai-inference	Azure AI推理REST客户端
@azure/core-auth	Azure身份验证实用程序
openai	OpenAI API的Node.js客户端

来源： requirements.txt package.json package-lock.json

环境配置

开发环境通过多个配置文件进行配置，以在不同的设置选项之间提供一致的体验。

容器配置

容器配置在.devcontainer/devcontainer.json中定义。

来源： .devcontainer/devcontainer.json .devcontainer/post-create.sh

容器配置指定了

• 基础镜像：mcr.microsoft.com/devcontainers/universal:2.11.2
• CPU要求：最少4个CPU
• VS Code扩展
  • ms-python.python
  • ms-toolsai.jupyter
• 创建后命令
  • 使用rustup安装Rust
  • 从requirements.txt安装Python依赖项

Visual Studio Code配置

使用VS Code（无论是在容器中还是本地），推荐以下设置

• 用于代码补全和linting的Python扩展
• 用于笔记本支持的Jupyter扩展
• 更好的体验的可选设置
  • 启用自动保存
  • 启用行内建议
  • 配置Python格式化程序

来源： .devcontainer/devcontainer.json11-26 vs.code-profile

API密钥管理

要使用本课程中的OpenAI或Azure OpenAI Service API，您需要安全地管理您的API密钥。

安全API密钥存储

务必确保您的API密钥安全，不要将其提交到公共存储库。推荐的方法是使用环境变量或不包含在git跟踪中的.env文件。

使用GitHub Codespaces时，您可以使用Codespace Secrets安全地存储您的API密钥。对于编码课程，需要访问Azure OpenAI Service或OpenAI API。

来源： 00-course-setup/translations/es-mx/README.md22-26 00-course-setup/translations/ko/README.md22-25 00-course-setup/translations/tw/README.md23-26

访问Azure OpenAI Service

使用Azure OpenAI Service

1. 通过在Azure OpenAI Service完成申请来请求访问权限
2. 创建并部署Azure OpenAI Service资源
3. 安全地存储您的API端点和密钥

对于首次用户，请参考创建和部署Azure OpenAI Service资源指南以获取详细说明。

来源： 00-course-setup/translations/es-mx/README.md112-115 00-course-setup/translations/ko/README.md109-111 00-course-setup/translations/tw/README.md118-120

故障排除

如果您在设置开发环境时遇到问题

1. 确保所有依赖项都已正确安装
2. 检查您的API密钥是否配置正确
3. 对于容器问题，请确保Docker已安装并正在运行
4. 对于Codespaces问题，请尝试创建一个新的codespace

如需额外帮助，请加入AI社区Discord服务器，与其他学习者交流并获得项目团队的支持。

来源： 00-course-setup/translations/es-mx/README.md117-123 00-course-setup/translations/ko/README.md113-119 00-course-setup/translations/tw/README.md126-133