{"id":26158211,"url":"https://github.com/airmomo/tpo-llm-webui","last_synced_at":"2025-12-24T22:16:42.124Z","repository":{"id":277511149,"uuid":"932321497","full_name":"Airmomo/tpo-llm-webui","owner":"Airmomo","description":"TPO 是一个优化 LLM 输出文本的框架，通过迭代反馈和优化提示的方式来“微调模型”，而非直接调整模型的参数，使模型在推理过程中与人类偏好对齐以生成更好的结果。本项目提供了一个友好的 WebUI 来加载模型，实时优化基础模型并展示最佳结果。","archived":false,"fork":false,"pushed_at":"2025-02-22T06:50:32.000Z","size":3624,"stargazers_count":9,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-11T10:46:18.114Z","etag":null,"topics":["llm","llm-training","tpo","web-ui"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Airmomo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-13T18:15:37.000Z","updated_at":"2025-03-02T04:40:25.000Z","dependencies_parsed_at":"2025-03-11T10:40:08.463Z","dependency_job_id":"c9b8023a-dfae-4403-acd4-4b6ba0ca06e1","html_url":"https://github.com/Airmomo/tpo-llm-webui","commit_stats":null,"previous_names":["airmomo/tpo-llm-webui"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Airmomo/tpo-llm-webui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Airmomo%2Ftpo-llm-webui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Airmomo%2Ftpo-llm-webui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Airmomo%2Ftpo-llm-webui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Airmomo%2Ftpo-llm-webui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Airmomo","download_url":"https://codeload.github.com/Airmomo/tpo-llm-webui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Airmomo%2Ftpo-llm-webui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28010640,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-24T02:00:07.193Z","response_time":83,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["llm","llm-training","tpo","web-ui"],"created_at":"2025-03-11T10:39:55.973Z","updated_at":"2025-12-24T22:16:42.108Z","avatar_url":"https://github.com/Airmomo.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TPO-LLM-WebUI 是什么\n\n[TPO（Test-Time Prompt Optimization）](https://github.com/yafuly/TPO)是一个用于优化大语言模型（LLM）输出文本的框架，它通过使用奖励模型和迭代反馈来指导基础模型生成结果更好的文本。\n\n`TPO-LLM-WebUI`则为提供了一个友好的 WebUI，你可以通过它来加载基础模型（LLM）和奖励模型，并且内置 TPO 框架以进行实时优化基础模型，它会对你的输入数据进行多轮评估和迭代反馈，使得基础模型在推理过程中与人类偏好对齐，生成更好的结果并展示。\n\n# 什么是“与人类偏好对齐”\n\n与人类偏好对齐，简单来说，就是让 AI 的行为（模型的推理过程/输出结果）更加符合人类的期望和价值观，生成更具价值（实用性）、安全性和真实性的结果。\n\n举个例子：\n- 假设你让AI写一首诗。\n    - 如果没有对齐： AI可能会写出一堆语法正确但毫无意义的句子，甚至可能包含冒犯性内容。\n    - 如果对齐了： AI会理解你想要一首优美、有意义的诗，并尽力创作出符合你期望的作品。\n\n# TPO 的主要功能\n\n- **动态对齐人类偏好**：TPO 能在模型推理时，根据奖励模型的反馈，动态调整模型的输出，更符合人类的偏好和期望。\n- **无需重新训练模型**：TPO 无需对模型进行重新训练或更新权重，可在推理阶段实现对模型输出的优化。\n- **高效优化与可扩展性**：TPO 在推理时的搜索宽度和深度上具有良好的可扩展性，能高效地优化模型输出。\n- **提升模型性能**：TPO 能显著提升模型在多个基准测试中的性能，更接近或超过经过训练时偏好对齐的模型。\n- **增强模型的解释性和可理解性**：TPO 通过文本反馈的形式，使模型的优化过程更加透明和可理解。\n- **提升推理稳定性**：TPO 能显著提升模型的推理稳定性，减少生成意外或有害响应的概率。\n- **轻量级和高效性**：TPO 是轻量级的优化方法，计算成本低，适合在实际应用中快速部署。\n\n# TPO 的技术原理\n\n![tpo_method](https://s2.loli.net/2025/02/13/Z742PqMVIyoxS5W.png)\n\n- **奖励信号转化为文本反馈**：TPO 的核心在于将奖励模型的数值信号转化为可解释的文本反馈。具体来说，模型在每次推理时生成多个候选响应，通过奖励模型对这些响应进行评分。然后，TPO 选择得分最高（“选择”响应）和得分最低（“拒绝”响应）的响应，分析它们的优势和不足，生成“文本损失”。\n- **迭代优化过程**：基于“文本损失”，TPO 生成“文本梯度”，这些梯度指导模型在下一次迭代中如何改进输出。过程类似于传统的梯度下降优化，但完全在文本层面进行，而不是直接更新模型参数。通过多次迭代，使得模型的输出逐渐与人类偏好对齐。\n- **依赖于模型的指令跟随能力**：TPO 的成功依赖于策略模型具备基础的指令跟随能力，因为模型必须能够准确解释和响应奖励模型的反馈。如果模型缺乏这种能力，TPO 可能无法有效地工作。\n\n# UCloud 介绍\n\n![UCloud](https://s2.loli.net/2025/02/13/dDV4fosLACQgpmJ.png)\n\n\u003e 优云智算是 UCloud 优刻得的GPU算力租赁平台，专注于为客户提供灵活、高效的算力资源。支持按天、按小时短期租赁及包月长期租赁，满足各类客户需求。\n\u003e 结合丰富的公共镜像社区，优云智算提供多种预配置的容器镜像，如LLamaFactory、SD-webUI 和 LLM 等，实现一键部署，5分钟就能快速上手 AI，助力客户快速启动和扩展项目。\n\n# 一键快速部署 TPO-LLM-WebUI\n\n在这里特别感谢 UCloud 优云智算提供的 GPU 算力支持！让项目得到了快速的部署和调试运行。\n\n## 1. 一键部署实例\n\n**TPO-LLM-WebUI 镜像发布页**：\u003chttps://www.compshare.cn/images-detail?ImageID=compshareImage-18jp6iuyn436\u0026ytag=GPU_hych_Lcsdn_csdn_display\u003e\n\n\u003e 【免费送你算力金】通过镜像发布页或下方链接注册可以额外获得40算力金，免费体验20小时顶配4090显卡，企业或高校认证后有95折和额外10元算力金。\n\u003e \u003chttps://passport.compshare.cn/register?referral_code=4sOb83sEXe4BLkKYqw9G4P\u0026ytag=GPU_hych_Lcsdn_csdn_display\u003e\n\n首先，在`镜像发布页`可以查看到我制作完成并分享到平台的实例镜像，通过页面右侧的`使用该镜像创建实例`可以快速创建一个实例。\n\n![UCloud_use_mirror](https://s2.loli.net/2025/02/14/JsKuEyzHUmXeWiG.png)\n\n## 2. 基础模型与系统配置选择(参考)\n\n- 通过镜像可以一键部署实例，同时需要根据模型的需求来确定使用的 GPU 数量，因为可用的 GPU 数量限制了张量并行的最大数量。\n- 例如，如果你只有 4 个 GPU，`--tensor-parallel-size` 的最大值只能是 4。\n\n| 模型名称                          | 显存需求（混合精度） | 4090 数量（24G/张）  | 推荐 `--tensor-parallel-size` |\n|-----------------------------------|----------------------|---------------|------------------------------|\n| **DeepSeek-R1-Distill-Qwen-7B**   | 14 GB                | 4090 单卡        | 1                            |\n| **DeepSeek-R1-Distill-Qwen-14B**  | 28 GB                | 4090 2卡| 2                            |\n| **DeepSeek-R1-Distill-Qwen-32B**  | 64 GB                | 4090 3卡| 3                            |\n| **DeepSeek-R1-Distill-Llama-70B** | 140 GB               | 4090 4卡| 4                            |\n\n![UCloud_mirror_ini_GPU-4](https://s2.loli.net/2025/02/14/GYMvsRPN1ImgULb.png)\n\n这里我选用 DeepSeek 的`DeepSeek-R1-Distill-Qwen-14B` 模型作为基础模型来获取更有性价比的运行结果，它需要**最低配置 4090 4卡**的运行环境下面的步骤都以该基础模型为例，如有出入请自行按说明修改参数配置。\n\n如果你的 GPU 预算不高，也可以选择使用较小的模型如`DeepSeek-R1-Distill-Qwen-7B`，按需选择 GPU 配置后再`立即部署`。\n\n#### 3. 启动实例\n\n稍等片刻后，实例就会自动创建并启动，通过查看`实例列表`可查看实例的运行状态，并支持随时关闭或启用。\n\n![UCloud_contorl](https://s2.loli.net/2025/02/13/Jw9BvKVS5POXW2k.png)\n\n实例同时提供了一个 `JupyterLab` 应用作为交互式开发环境，它提供了更现代化和灵活的用户界面，方便我们继续后续的步骤。\n\n![UCloud_JupyterLab](https://s2.loli.net/2025/02/13/utpxBdQqGCMOZSA.png)\n\n# 如何运行 TPO-LLM-WebUI\n\n## 1. 运行环境准备\n\n**通过镜像一键部署实例可跳过该步骤，虚拟环境及其所需的依赖均已在实例内配置完成，你可以直接跳过该步骤继续运行。**\n\n本地部署按照以下步骤配置运行环境：\n\n1. 创建虚拟环境\n\n```bash\nconda create -n tpo python=3.10\nconda activate tpo\n```\n\n没有安装conda的可以使用以下命令创建和激活虚拟环境：\n```bash\npython -m venv tpo\nsource tpo/bin/activate\n```\n\n2. 下载并安装依赖\n```bash\ngit clone https://github.com/Airmomo/tpo-webui.git\npip install -r requirements.txt\n```\n\n3. 安装 TextGrad\n```bash\ncd textgrad-main\npip install -e .\ncd ..\n```\n\n## 2. 下载基础模型和奖励模型\n\n**通过镜像一键部署实例可跳过该步骤，运行需要的模型均在镜像内已内置，你可以直接跳过该步骤继续运行。**\n\n本地部署则需要手动下载模型放到加载模型时指定的目录路径中`（如：/model/HuggingFace/...）`。：\n\n- 基础模型：https://huggingface.co/deepseek-ai/DeepSeek-R1-Distill-Qwen-32B\n- 奖励模型：https://huggingface.co/sfairXC/FsfairX-LLaMA3-RM-v0.1\n\n当然你也可以选择下载其他大语言模型（LLM）作为基础模型或其他奖励模型进行优化训练，**你可以在'config.yaml'中修改使用的模型**（本地路径或远程 HuggingFace 仓库的标识符），但是要注意根据自己的 GPU 配置来选择合适的模型，量力而行！\n\n## 3. 启动 vLLM 服务\n\n这里使用 vLLM 服务器托管将使用 TPO 进行优化的基础模型，使用 2 个 GPU 以张量并行的方式部署，将模型下载到本地后放到指定的路径中`（/model/HuggingFace/...）`，然后在终端输入以下命令：\n\n```bash\nvllm serve /model/HuggingFace/deepseek-ai/DeepSeek-R1-Distill-Qwen-14B \\\n    --dtype auto \\\n    --api-key token-abc123 \\\n    --tensor-parallel-size 2 \\\n    --max-model-len 59968 \\\n    --port 8000\n```\n\n简而言之，这个命令会启动一个 `vLLM` 服务，加载 `DeepSeek-R1-Distill-Qwen-14B` 模型，使用 2 个 GPU 进行张量并行推理，最大上下文窗口支持 59968 个序列长度，并在端口 8000 上提供服务。\n\n以下是主要参数的解释：\n\n| 命令/参数名称                     | 作用                                                                 |\n|--------------------------|----------------------------------------------------------------------|\n| `vllm serve`             | 启动 `vLLM` 服务模式。                                               |\n| `deepseek-ai/DeepSeek-R1-Distill-Qwen-14B` | 指定要加载的模型。                                                   |\n| `--dtype auto`           | 自动选择模型权重的数据类型。                                         |\n| `--api-key token-abc123` | 设置 API 密钥，保护服务访问，这里设置为`token-abc123`。                                        |\n| `--tensor-parallel-size 2` | 根据当前的系统配置，设置张量并行大小为 2，即使用 2 个 GPU。                                |\n| `--max-model-len 59968`  | 根据当前的系统配置，模型支持的最大序列长度为 59968。                                 |\n| `--enforce-eager`        | 强制使用 eager 模式，便于调试，这里可不开启。                                      |\n| `--port 8000`            | 指定服务监听的端口号为 8000。                                        |\n\n## 4. 运行 TPO-LLM-WebUI 的注意事项\n\n一般情况下 TPO 框架建议在单机单GPU环境中运行。若服务器资源足够，你也尝试可以在同一环境中运行。\n\n在终端输入以下指令可以帮助你确定当前系统配置的GPU数量及显存分配情况：\n```bash\nwatch -n 1 nvidia-smi\n```\n\n在多 GPU 且资源有限的环境下，TPO 默认 Pytorch 会自动分配模型到多个 GPU 上。\n假设分配到了一个正在被其他模型使用的 GPU 上时，则可能会发生显存溢出的情况，导致程序报错而停止运行。所以在这种多GPU的环境中，你需要确保 TPO 使用的 GPU 设备是空闲的，并且可以分配给 TPO 脚本使用。\n\n比如在 4 个 GPU 的环境中，基础模型仅使用了 2 个 GPU （GPU 0 和 GPU 1）的情况下，我可以使用以下命令限制启动 TPO 脚本时 Pytorch 使用的 GPU 设备，如下命令表示使用第 2 个和第 3 个 GPU，注意该命令只在当前终端窗口有效：\n```bash\nexport CUDA_VISIBLE_DEVICES=2,3\n```\n\n## 5. 运行 TPO 优化模型输出\n\n### 运行方式一：运行 TPO-LLM-WebUI（实时优化模型和展示输出结果）\n\n`TPO-LLM-WebUI` 服务默认通过 `7860` 端口进行访问，详细可查看`gradio_app.py`，镜像已经配置了端口转发。\n\n在启动 vLLM 服务后，**新建一个终端窗口**输入以下命令来快速启动 TPO WebUI 服务并**支持公网访问**：\n```bash\npython gradio_app.py\n```\n\n启动后，你可以通过浏览器访问 WebUI：\n\n- 先在`模型设置`初始化模型，连接 vLLM 服务器和加载奖励模型（预计耗时1～2分钟）。\n\n![tpo_model_init](https://s2.loli.net/2025/02/13/qBN1A4IM78HWcih.png)\n\n- 模型初始化成功后，就可以到`优化设置`页尽情体验啦！输入问题后点击`开始优化`按钮即可。\n\n![tpo_result](https://s2.loli.net/2025/02/13/VCidEf1m8Wv2GOS.png)\n\n### 运行方式二：手动执行 TPO 脚本（类似预训练的优化方式）\n\n在终端输入以下命令以执行 TPO 脚本，该脚本会先加载一个奖励模型（预计耗时1～2分钟）与作为 vLLM 服务器部署的策略模型进行交互：\n\n```bash\npython run.py \\\n   --data_path data/sample.json \\\n   --ip 0.0.0.0 \\\n   --port 8000 \\\n   --server_model /model/HuggingFace/deepseek-ai/DeepSeek-R1-Distill-Qwen-14B \\\n   --reward_model /model/HuggingFace/sfairXC/FsfairX-LLaMA3-RM-v0.1 \\\n   --tpo_mode tpo \\\n   --max_tokens_response 2048 \\\n   --max_tokens_all 8192 \\\n   --sample_size 5 \\\n   --seed 7 \\\n   --max_iterations 2 \\\n   --num_threads 4\n```\n\n- **注意**：`sample_size` 可能会由于优化过程中的多次迭代而产生多个结果，导致最终显示的结果数量超过了设定值。\n\n主要的参数说明如下：\n\n| 参数名称| 作用 |\n|----------------------|--------------------|\n| `data_path`           | 数据文件路径（JSON格式）。更多详情请参考 `data/sample.json`。 |\n| `ip`                  | vLLM 服务器的 IP 地址，例如 `localhost` 或 `127.0.0.1`。 |\n| `port`                | vLLM 服务器的端口号，例如 `8000`。 |\n| `server_model`        | 通过 API 提供服务的基础模型，例如 `deepseek-ai/DeepSeek-R1-Distill-Qwen-14B`。 |\n| `reward_model`        | 奖励模型的HuggingFace仓库位置或模型的本地路径，例如 `sfairXC/FsfairX-LLaMA3-RM-v0.1` 或 `/model/HuggingFace/sfairXC/FsfairX-LLaMA3-RM-v0.1`。 |\n| `sample_size`         | 每一步采样的响应数量。 |\n| `max_iterations`      | 测试时优化的最大迭代次数。 |\n| `num_threads`         | 用于生成的线程数。增加 `num_threads` 可以通过同时利用多个处理核心来加快生成速度，从而**提高效率**。在计算资源有限的情况下，建议设置为 1。 |\n\n# TPO 脚本的运行流程\n\n1. 预处理阶段：\n   - 运行`run.py`脚本会读取你的输入数据（通过`--data_path`参数指定的 JSON 文件）\n   - 对每个输入进行多轮优化\n2. 优化过程：\n   - 对每个输入查询，会进行`max_iterations`次迭代）\n   - 每次迭代会：\n     - 生成多个候选回答（由`sample_size`参数控制）\n     - 使用奖励模型评估这些回答。\n     - 选择最佳回答并优化提示。\n3. 结果保存：\n   - 优化后的结果会保存在输出文件中，之后你可以直接使用这些优化过的结果。\n\n运行脚本后，会在`logs/`目录下生成日志文件，以JSON格式存储，你可以详细地跟踪每次迭代的优化过程。","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fairmomo%2Ftpo-llm-webui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fairmomo%2Ftpo-llm-webui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fairmomo%2Ftpo-llm-webui/lists"}