项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 10289
技术标签
使用教程
ℹ 本教程由 AI 依据该项目 README 整理,个别步骤可能需要按你的环境微调。
环境要求
- Python 环境(Soup 为 Python 编写的命令行应用,PyPI 包名 soup-cli)
- 本地需要可用的 GPU 与 CUDA/PyTorch;不想装 CUDA/PyTorch 可用官方 Docker 镜像
- 训练数据为 alpaca 格式的 JSONL 文件(示例:./data/train.jsonl)
- Windows 下执行 Docker 挂载命令请改用 PowerShell 语法
安装与启动步骤
-
1安装 Soup CLI
README 提示为 Soup 单独建一个环境并把 soup 放到 PATH;安装包为 PyPI 上的 soup-cli,安装后用 soup 命令调用。
pip install soup-cli -
2编写配置文件
新建 soup.yaml,至少写清基座模型、任务类型、训练数据路径与输出目录。字段以 config/schema.py 为准。
-
3准备训练数据
按 alpaca 格式准备 JSONL 训练数据,放到配置里 data.train 指定的位置,例如项目下的 ./data/train.jsonl。
-
4启动微调
在 soup.yaml 所在目录执行训练命令,Soup 会读取该配置完成整个微调流程,结果写入 output 指定的目录。
soup train --config soup.yaml -
5改用 Docker 运行
不想本地安装 CUDA/PyTorch 时,拉取官方 GHCR 镜像并把当前目录挂载到容器 /workspace,再用 --gpus all 透传 GPU。
docker pull ghcr.io/makazhanalpamys/soup:latest docker run --gpus all -v $(pwd):/workspace ghcr.io/makazhanalpamys/soup train --config soup.yaml -
6或用 Docker Compose
仓库自带 compose 配置,可直接一键起容器,也可在本地构建镜像后再启动。
docker compose up
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
base | 是 | 指定要微调的基座模型(Hugging Face 模型名) | meta-llama/Llama-3.1-8B-Instruct |
task | 是 | 训练任务类型,示例为 sft 监督微调 | sft |
backend | 否 | 切换训练后端,unsloth 可提速 2-5 倍,需另装 fast 依赖 | unsloth |
data.train | 是 | 训练数据文件路径 | ./data/train.jsonl |
data.format | 否 | 数据格式,示例使用 alpaca | alpaca |
output | 是 | 训练产物输出目录 | ./output |
如何确认成功
命令开始执行并输出训练日志,训练结束后在 output 指定的目录(示例 ./output)能看到产物。
常见问题
Q:只有 4GB 显存的笔记本 GPU 能微调 8B 模型吗?
A:可以。Soup 采用层流式训练技术,示例配置还对模型做 4bit 量化(quantization: 4bit),从而在低显存下训练 8B 参数模型。
Q:配置文件里多写了一个键为什么直接报错?
A:从 v0.75 起未知配置键会被拒绝加载,拼写错误(如 quantizaton)或版本不支持的字段都会导致配置读取失败,v0.74 之前只是提示,现在必须修正或删除该键。
Q:训练速度太慢怎么提速?
A:安装加速依赖 pip install "soup-cli[fast]",并在 soup.yaml 中把 backend 设为 unsloth,README 称可提速 2-5 倍。
Q:不想在本地装 CUDA 和 PyTorch 怎么办?
A:使用官方 Docker 镜像 ghcr.io/makazhanalpamys/soup:latest,配合 docker run 或在仓库内直接 docker compose up 运行。
Q:Docker 跑起来没用上 GPU?
A:docker run 时必须加 --gpus all 参数,否则容器内无法访问宿主显卡。
注意事项
- v0.75 起未知配置键会导致配置加载失败,不要依赖“写了但被忽略”。
- config/schema.py 是所有配置字段的唯一来源,进阶数据、训练与 PEFT 选项以官方 Documentation 为准。
- Docker 运行需 --gpus all 并使用 -v $(pwd):/workspace 挂载工作目录,Windows PowerShell 下挂载语法不同。
核心亮点
- 配置驱动,一个YAML文件即可定义完整微调流程,上手门槛低
- 层流式训练技术显著降低显存占用,让消费级显卡训练大模型成为可能
- 支持8B级模型微调,兼顾模型性能与硬件可行性
不足之处
- 项目处于早期阶段,文档和社区支持尚待完善
- 层流式训练可能对模型收敛速度和最终精度有影响,需实际验证
适用场景
- 个人开发者或学术研究者在低配GPU上微调大模型
- 快速原型验证,用YAML配置快速迭代微调实验
- 资源受限的初创团队定制垂直领域模型
替代项目
Hugging Face PEFT、Unsloth、Axolotl
上一篇:evostra
同类项目推荐
ts-icl
开源
零样本搞定时间序列预测与插补,无需重新训练。
TS-ICL: a Time-Indexed Foundation Model for Time Series Forecasting & Imputation via···
Flow-Factory
开源
让流匹配模型轻松学会强化学习,生成更符合目标的结果
A unified framework for easy fine-tuning in Flow-Matching models
pruna
开源
一键优化 AI 模型,推理提速又省资源。
Pruna is a model optimization framework built for developers, enabling you to delive···
Confucius-tool-learning
开源
让大模型通过自我反思学会用工具,从易到难逐步精通
Official Repo for AAAI 2024 paper "Confucius: Iterative Tool Learning from Introspec···
LiteResearcher
开源
用强化学习训练会查资料、写长报告的深度研究智能体
[COLM 2026] A Scalable Agentic RL Training Framework for Deep Research Agent
MoE-plus-plus
开源
零计算专家,让MoE模型更快更省,性能不减
[ICLR 2025] MoE++: Accelerating Mixture-of-Experts Methods with Zero-Computation Exp···
Long-RL
开源
让强化学习轻松驾驭超长序列,训练更稳更快
Long-RL: Scaling RL to Long Sequences (NeurIPS 2025)
DARE
开源
给扩散大模型做对齐和强化训练的开源执行器
[COLM 2026] Official repository of DARE: Diffusion Large Language Models Alignment a···
MLOps
开源
跟着项目清单,动手练熟MLOps全流程
The repository contains a list of projects which I will work on while learning and i···
