项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 8484
使用教程
环境要求
- Linux 系统(README 基于 Ubuntu 20.04 测试,MacOS/Windows 未充分测试)
- 已安装 Git 与 Conda
- Python 3.9(由 conda 创建的环境提供)
- 本地需自备 LLaMA 基座模型路径,及 LoRA 权重(如 robin-7b)
- 部署聊天界面需额外安装 gradio
安装与启动步骤
-
1克隆仓库
拉取 v1.0.0 分支代码,README 说明最新版改动较大,此处按官方命令指定版本
git clone -b v1.0.0 https://github.com/OptimalScale/LMFlow.git -
2进入项目目录
后续所有安装命令都在该目录下执行
cd LMFlow -
3创建 conda 环境
使用 Python 3.9 新建名为 lmflow 的独立环境,避免污染系统环境
conda create -n lmflow python=3.9 -y -
4激活环境
切换到刚创建的 lmflow 环境,之后的 pip 安装都作用于它
conda activate lmflow -
5安装依赖并安装项目
先通过 conda 安装 mpi4py,再以可编辑模式安装 LMFlow 本体
conda install mpi4py pip install -e . -
6安装 Gradio
部署本地聊天界面需要 gradio,README 中单独给出安装命令
pip install gradio -
7启动对话 Demo
按 README 命令启动基于 Gradio 的聊天机器人,需把 YOUR-LLAMA 换成本地 LLaMA 模型路径
python ./examples/chatbot_gradio.py --deepspeed configs/ds_config_chatbot.json --model_name_or_path YOUR-LLAMA --lora_model_path ./robin-7b --prompt_structure "A chat between a curious human and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the human's questions.###Human: {input_text}###Assistant:" --end_string "#" --max_new_tokens 200
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
--model_name_or_path | 是 | 指定本地 LLaMA 基座模型路径 | YOUR-LLAMA |
--lora_model_path | 是 | 指定 LoRA 权重目录,README 示例为 robin-7b | ./robin-7b |
--deepspeed | 是 | 指定 DeepSpeed 配置文件,实现推理加速 | configs/ds_config_chatbot.json |
--prompt_structure | 是 | 对话提示词模板,含 {input_text} 占位符 | A chat between a curious human and an artificial intelligenc |
--end_string | 是 | 生成结束标记,遇到即停止输出 | # |
--max_new_tokens | 否 | 单轮生成的最大新 token 数 | 200 |
如何确认成功
命令运行无报错并输出 Gradio 访问地址,浏览器打开该地址可与模型正常对话,即部署成功。
常见问题
Q:可以在 Windows 或 MacOS 上安装吗?
A:README 说明项目仅在 Linux(Ubuntu 20.04)上测试通过,MacOS、Windows 未充分测试可能报错,建议在 Linux 机器或 Google Colab 上尝试。
Q:想使用旧版本怎么办?
A:README 指出最新版改动较大,如需旧版本可执行 git checkout v0.0.10,或直接使用仓库中的 v0.0.10 分支。
Q:启动 Demo 时提示找不到模型怎么办?
A:--model_name_or_path 必须替换为本地真实的 LLaMA 模型目录,--lora_model_path 指向实际的 LoRA 权重目录(如 ./robin-7b),路径错误会直接报错。
Q:conda install mpi4py 失败怎么办?
A:README 将 mpi4py 放在 conda 环境中安装,请确认已 conda activate lmflow 后再执行;若仍失败可换用 Linux 环境或 Google Colab 重试。
注意事项
- README 明确建议首次使用者在 Linux 机器或 Google Colab 上尝试,避免非 Linux 平台的兼容问题。
- 仓库需按 v1.0.0 分支克隆,直接使用 main 分支可能与教程命令不一致。
- 示例中的 YOUR-LLAMA 与 ./robin-7b 均为占位,需替换为你自己的模型与 LoRA 权重路径。
- 安装全程应在已激活的 lmflow conda 环境中执行,否则依赖会装到错误环境。
核心亮点
- 支持 LoRA/QLoRA 等高效微调,大幅降低显存和计算成本
- 提供统一 API 和命令行,从数据处理到推理部署全流程覆盖
- 兼容 LLaMA、GPT 等主流模型,社区活跃且文档示例丰富
不足之处
- 部分高级功能依赖较新硬件,老旧设备兼容性一般
- 文档/社区待观察
适用场景
- 研究者快速实验不同微调策略,对比效果
- 中小企业基于开源模型定制垂直领域助手
- 个人开发者低成本部署私有化聊天机器人
替代项目
Hugging Face Transformers、PEFT、DeepSpeed
上一篇:aikit
下一篇:minimind-o
同类项目推荐
automix
开源
让多个AI模型互相验证,推理结果更靠谱
Mixing Language Models with Self-Verification and Meta-Verification
OneGen
开源
一次前向传播,边生成边检索,让 LLM 知识问答更快更准。
[EMNLP 2024] OneGen: Efficient One-Pass Unified Generation and Retrieval for LLMs.
vector-quantize-pytorch
开源
一行替换量化层,轻松训练离散潜变量模型
Vector (and Scalar) Quantization, in Pytorch
vertex-ai-mlops
开源
照着做,就能在 Google Cloud 上跑通生产级 ML 流水线
Google Cloud Platform Vertex AI end-to-end workflows for machine learning operations
gflownet
开源
按奖励比例采样多样化候选解的生成模型框架
Generative Flow Networks - GFlowNet
maji-merger
开源
在 WebUI 里拖拽调参,几秒合并出全新模型
A WebUI extension for model merging
HALC
开源
减少多模态模型幻觉,让AI描述更可信
[ICML 2024] Official implementation for "HALC: Object Hallucination Reduction via Ad···
distill-sd
开源
把大模型蒸馏成小模型,低显存也能跑高质量图像生成
Segmind Distilled diffusion
easevoice-trainer
开源
简单几步,训练你的专属语音克隆模型
EaseVoice Trainer is a simple and user-friendly voice cloning and speech model train···
