233 lines
5.9 KiB
Markdown
233 lines
5.9 KiB
Markdown
<div align="center">
|
||
|
||
<img src="../images/logo.png" width="auto" alt="Logo">
|
||
|
||
<div>
|
||
<a href="../../README.md">English</a> •
|
||
<a href="#chinese">中文</a>
|
||
</div>
|
||
|
||
<p>
|
||
<strong>轻量级 Transformer 训练与推理框架</strong>
|
||
</p>
|
||
</div>
|
||
|
||
<div align="center">
|
||
<img src="https://img.shields.io/badge/python-3.12+-blue.svg" alt="python">
|
||
<img src="https://img.shields.io/badge/license-GPL--3.0-blue.svg" alt="license">
|
||
<img src="https://img.shields.io/github/v/release/ViperEkura/AstrAI?color=76bad9" alt="release">
|
||
<img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.github.com%2Frepos%2FViperEkura%2FAstrAI&query=%24.stargazers_count&label=stars&suffix=%20stars&color=76bad9" alt="stars">
|
||
<img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.github.com%2Frepos%2FViperEkura%2FAstrAI&query=%24.forks_count&label=forks&suffix=%20forks&color=76bad9" alt="forks">
|
||
</div>
|
||
|
||
<br>
|
||
|
||
<div align="center">
|
||
<a href="../../README.md">English</a> •
|
||
<a href="#chinese">中文</a> •
|
||
<a href="https://github.com/ViperEkura/AstrAI/issues">问题追踪</a> •
|
||
<a href="https://github.com/ViperEkura/AstrAI/discussions">讨论区</a> •
|
||
<a href="https://huggingface.co/ViperEk">HuggingFace</a>
|
||
</div>
|
||
<br>
|
||
|
||
## 📖 目录
|
||
|
||
- [特性](#特性)
|
||
- [快速开始](#快速开始)
|
||
- [文档](#文档)
|
||
- [贡献](#贡献)
|
||
- [社区](#社区)
|
||
- [许可证](#许可证)
|
||
|
||
---
|
||
|
||
<a id="chinese"></a>
|
||
## 中文
|
||
|
||
### 特性
|
||
|
||
- 🚀 **高性能**: 训练与推理双向优化，高效并行。
|
||
- 🔧 **灵活**: 支持 seq/sft/dpo/grpo 多种训练方式，可定制模型架构。
|
||
- 💡 **易用**: 简洁的 API 与丰富的示例、演示。
|
||
- 📦 **轻量**: 依赖少，部署简单。
|
||
- 🔬 **研究友好**: 模块化设计，便于实验新想法。
|
||
- 🤗 **HuggingFace 集成**: 兼容 HuggingFace 模型与数据集。
|
||
- 🔌 **双 API 兼容**: 同时支持 OpenAI 和 Anthropic 聊天补全 API，开箱即用。
|
||
|
||
### 快速开始
|
||
|
||
#### 安装
|
||
|
||
```bash
|
||
git clone https://github.com/ViperEkura/AstrAI.git
|
||
cd AstrAI
|
||
pip install -e .
|
||
```
|
||
|
||
安装开发依赖：
|
||
|
||
```bash
|
||
pip install -e ".[dev]"
|
||
```
|
||
|
||
#### 训练模型
|
||
|
||
```bash
|
||
CUDA_VISIBLE_DEVICES=0,1,2,3 python scripts/tools/train.py \
|
||
--train_type seq \
|
||
--data_root_path /path/to/dataset \
|
||
--param_path /path/to/model \
|
||
--batch_size 4 \
|
||
--accumulation_steps 8 \
|
||
--max_lr 3e-4 \
|
||
--warmup_steps 1000 \
|
||
--n_epoch 1
|
||
```
|
||
|
||
完整参数列表见[参数说明](./params.md)。
|
||
|
||
#### 文本生成
|
||
|
||
```bash
|
||
python scripts/tools/generate.py --param_path=/path/to/param_path
|
||
```
|
||
|
||
#### Docker
|
||
|
||
使用 Docker 构建和运行（推荐用于 GPU 环境）：
|
||
|
||
```bash
|
||
# 构建镜像
|
||
docker build -t astrai:latest .
|
||
|
||
# 启用 GPU 运行
|
||
docker run --gpus all -it astrai:latest
|
||
|
||
# 指定特定 GPU
|
||
docker run --gpus '"device=0,1"' -it astrai:latest
|
||
|
||
# 运行推理服务
|
||
docker run --gpus all -p 8000:8000 astrai:latest \
|
||
python -m scripts.tools.server --port 8000 --device cuda
|
||
|
||
# 挂载数据卷
|
||
docker run --gpus all -v /path/to/data:/data -it astrai:latest
|
||
|
||
# Docker Compose（GPU，默认）
|
||
docker compose up -d
|
||
|
||
# Docker Compose（仅 CPU）
|
||
docker compose --profile cpu up -d
|
||
```
|
||
|
||
> **注意**: 必须使用 `--gpus all` 才能启用 CUDA 支持，否则 `torch.cuda.is_available()` 将返回 `False`。
|
||
|
||
#### 启动 HTTP 服务
|
||
|
||
启动推理服务器，支持 OpenAI 和 Anthropic 兼容的 HTTP API：
|
||
|
||
```bash
|
||
python -m scripts.tools.server --port 8000 --device cuda
|
||
```
|
||
|
||
发起请求：
|
||
|
||
```bash
|
||
# OpenAI 兼容
|
||
curl -X POST http://localhost:8000/v1/chat/completions \
|
||
-H "Content-Type: application/json" \
|
||
-d '{
|
||
"messages": [{"role": "user", "content": "你好"}],
|
||
"max_tokens": 512
|
||
}'
|
||
|
||
# OpenAI 兼容流式
|
||
curl -X POST http://localhost:8000/v1/chat/completions \
|
||
-H "Content-Type: application/json" \
|
||
-d '{
|
||
"messages": [{"role": "user", "content": "讲个故事"}],
|
||
"stream": true,
|
||
"max_tokens": 500
|
||
}'
|
||
|
||
# Anthropic 兼容
|
||
curl -X POST http://localhost:8000/v1/messages \
|
||
-H "Content-Type: application/json" \
|
||
-d '{
|
||
"model": "astrai",
|
||
"system": "你是一个乐于助人的助手。",
|
||
"messages": [{"role": "user", "content": "你好"}],
|
||
"max_tokens": 512
|
||
}'
|
||
|
||
# Anthropic 兼容流式并设置停止序列
|
||
curl -X POST http://localhost:8000/v1/messages \
|
||
-H "Content-Type: application/json" \
|
||
-d '{
|
||
"model": "astrai",
|
||
"messages": [{"role": "user", "content": "写个故事"}],
|
||
"max_tokens": 500,
|
||
"stream": true,
|
||
"stop_sequences": ["结束"]
|
||
}'
|
||
|
||
# 健康检查
|
||
curl http://localhost:8000/health
|
||
```
|
||
|
||
#### 演示
|
||
|
||
查看 `scripts/demo/` 文件夹中的演示：
|
||
|
||
```bash
|
||
# 下载预处理数据（运行演示前必需）
|
||
python scripts/demo/download.py
|
||
|
||
# 交互式流式聊天
|
||
python scripts/demo/stream_chat.py
|
||
|
||
# 批量生成
|
||
python scripts/demo/generate_batch.py
|
||
|
||
# 自回归生成
|
||
python scripts/demo/generate_ar.py
|
||
```
|
||
|
||
观看 [bilibili](https://www.bilibili.com/video/BV1z5RPYHEkd) 上的视频演示。
|
||
|
||
### 文档
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [参数说明](./params.md) | 训练与推理参数配置 |
|
||
| [设计文档](./design.md) | 系统架构与模块设计 |
|
||
| [数据流程](./dataflow.md) | 数据处理管道详解 |
|
||
| [模型介绍](./introduction.md) | 模型架构与技术细节 |
|
||
|
||
### 贡献
|
||
|
||
我们欢迎贡献！请参阅[贡献指南](../../CONTRIBUTING.md)了解详情。
|
||
|
||
1. Fork 本仓库。
|
||
2. 创建功能分支。
|
||
3. 提交更改。
|
||
4. 发起 Pull Request。
|
||
|
||
重大更改请先开 issue 讨论。
|
||
|
||
### 社区
|
||
|
||
- **GitHub Issues**: [问题追踪](https://github.com/ViperEkura/AstrAI/issues)
|
||
- **Discussions**: [GitHub 讨论区](https://github.com/ViperEkura/AstrAI/discussions)
|
||
- **HuggingFace**: [模型中心](https://huggingface.co/ViperEk)
|
||
|
||
### 许可证
|
||
|
||
本项目采用 [GPL-3.0 许可证](../../LICENSE)。
|
||
|
||
---
|
||
|
||
<div align="center">
|
||
<em>专为高性能与易用性设计的轻量级 Transformer 框架。</em>
|
||
</div> |