Foundry Local 项目启动与配置教程

1. 项目的目录结构及介绍

Foundry Local 项目的主要目录结构如下：

• docs/: 存放项目的文档。
• licenses/: 包含项目使用的许可证文件。
• media/: 存储与项目相关的媒体文件，如图标等。
• samples/: 包含示例代码和项目示例。
• sdk/: 存放项目的软件开发工具包（SDK）相关文件。
• .gitattributes: 指定如何处理不同文件类型的换行符。
• .gitignore: 指定Git应该忽略的文件和目录。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 指导如何为项目贡献代码。
• LICENSE: 项目的许可证文件。
• README.md: 项目的自述文件，包含项目介绍和如何使用的信息。
• SECURITY.md: 项目的安全策略。
• SUPPORT.md: 提供项目支持信息的文档。

2. 项目的启动文件介绍

项目的启动主要通过命令行操作。以下是一些基本命令：

• 安装 Foundry Local：

  • Windows: winget install Microsoft.FoundryLocal
  • MacOS: brew tap microsoft/foundrylocal && brew install foundrylocal

• 运行第一个模型：

  • 终端中运行 foundry model run phi-3.5-mini 命令。如果模型尚未缓存到本地，该命令将自动下载模型，并启动一个与模型的交互式聊天会话。

• 列出所有可用模型：

  • 运行 foundry model ls 命令，将显示所有可以本地运行的模型列表，包括它们的名称、大小和其他详细信息。

3. 项目的配置文件介绍

项目的配置主要通过环境变量和命令行参数进行。以下是一些配置选项：

• 使用SDK时，可以通过设置环境变量来配置SDK的行为。
• 在运行模型时，可以通过命令行参数来指定不同的模型版本或配置。

例如，使用Python SDK时，可以这样配置：

from foundry_local import FoundryLocalManager
alias = "phi-3.5-mini"
manager = FoundryLocalManager(alias)

在JavaScript SDK中，配置方式如下：

import { FoundryLocalManager } from "foundry-local-sdk";
const alias = "phi-3.5-mini";
const foundryLocalManager = new FoundryLocalManager();
await foundryLocalManager.init(alias);

确保在运行任何命令之前，已经正确配置了所有必要的环境变量和参数。