第5章 LMQL安装指南

安装说明

要在本地安装 LMQL，请在 Python >=3.10 环境中执行以下命令。

```bash pip install lmql ```

本地 GPU 支持：如果想在本地 GPU 上运行模型，请确保在包含 GPU 版本 PyTorch >= 1.11 的环境中安装 LMQL。 通过 pip 安装带有 GPU 依赖项的 LMQL，请执行 `pip install lmql[hf]`。

Playground 若需快速进行实验，也可以使用基于 Web 的 Playground IDE。

运行 LMQL 程序

Playground 安装完成后，可使用以下命令启动本地 Playground IDE 实例：

```bash lmql playground ```

信息 使用 LMQL playground 需要安装 Node.js。如果在 conda 管理的环境中，可以通过 `conda install nodejs=14.20 -c conda-forge` 安装 node.js。否则，请参阅 Node.js 官方网站了解如何在系统上安装。

这将启动一个基于浏览器的 Playground IDE，其中包含许多 LMQL 程序示例。如果 IDE 未自动打开，请访问 http://localhost:3000。

命令行界面 作为 playground 的替代方案，可以使用命令行工具 `lmql run` 来执行本地 `.lmql` 文件。

Python 集成 LMQL 也可以直接在 Python 中使用。要在 Python 中使用 LMQL，可以导入 `lmql` 包，通过 `lmql.run` 运行查询代码，或使用装饰器 `@lmql.query` 定义 LMQL 查询函数。

更多细节请参阅 Python 集成章节。

自托管模型

注意：在 Playground IDE 中或通过 `lmql run` 使用本地 Hugging Face Transformers 模型时，必须首先通过命令 `lmql serve-model` 为对应模型启动一个 LMQL 推理 API 实例。

更多细节请参阅 Hugging Face 模型章节。

配置 OpenAI API 凭据

如果想使用 OpenAI 模型，必须配置 API 凭据。可以通过定义 `OPENAI_API_KEY` 环境变量，或者在当前工作目录下创建 `api.env` 文件来实现，内容如下：

``` openai-org: <组织标识符> openai-secret: ```

若需进行系统级配置，也可以在 `$HOME/.lmql/api.env` 或 LMQL 发行版的项目根目录（例如开发副本中的 `src/`）下创建 `api.env` 文件。