# ffRAG

**Repository Path**: feifei14119/ff-rag

## Basic Information

- **Project Name**: ffRAG
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-06
- **Last Updated**: 2026-07-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ffRAG

> 基于本地大模型的 Excel 文件检索增强生成（RAG）系统

## 项目简介

ffRAG 是一个完全本地化的 RAG 系统，让你可以用自然语言查询 Excel 文件中的数据，无需上传到云端，数据完全私密。

## 硬件要求

| 项目 | 最低要求 | 推荐配置 |
|------|----------|----------|
| 操作系统 | Windows 10+ | Windows 11 |
| 内存 | 16 GB | **32 GB** |
| 存储 | 20 GB 可用空间 | SSD |
| GPU | 不需要（纯 CPU 推理） | 不需要 |

## 快速开始

### 1. 克隆项目

```powershell
cd C:\Users\feife\repo
git clone <repo-url> ffRAG
cd ffRAG
```

### 2. 安装依赖

```powershell
pip install -r requirements.txt
```

### 3. 下载模型（首次运行自动下载）

模型文件较大（约 4-8 GB），可通过以下方式获取：

**LLM 模型（Qwen2.5-7B Q4 量化版）**
- 推荐从 HuggingFace 下载：`Qwen/Qwen2.5-7B-Instruct-GGUF`
- 或使用 Modelscope 镜像

**Embedding 模型（bge-small-zh-v1.5）**
- `BAAI/bge-small-zh-v1.5`
- 模型较小（约 100 MB），首次运行自动下载

### 4. 放置 Excel 文件

将待分析的 Excel 文件放入：
```
data/excel/
```

### 5. 构建索引

```powershell
python scripts/build_index.py
```

### 6. 开始查询

```powershell
# 交互模式
python scripts/interactive.py

# 单次查询
python scripts/query.py "2024年销售额最高的产品是什么？"
```

## 项目结构

```
ffRAG/
├── src/               # 源代码
├── scripts/           # 运行脚本
├── data/
│   ├── excel/         # Excel 文件目录
│   └── vector_db/     # 向量数据库存储
├── models/
│   ├── llm/           # LLM 模型（GGUF 格式）
│   └── embedding/     # Embedding 模型
├── docs/              # 详细文档
└── requirements.txt   # 依赖列表
```

## 技术栈

| 组件 | 选型 |
|------|------|
| LLM | Qwen2.5-7B-Instruct (GGUF Q4_K_M) |
| Embedding | bge-small-zh-v1.5 |
| 向量库 | Chroma |
| Excel 解析 | openpyxl + pandas |
| RAG 框架 | LlamaIndex |
| 推理引擎 | llama-cpp-python |

详见 [docs/PROJECT_PLAN.md](docs/PROJECT_PLAN.md)

## 文档

- [项目规划总览](docs/PROJECT_PLAN.md) ← 你正在看的文档
- [架构设计文档](docs/ARCHITECTURE.md)（待生成）
- [用户使用手册](docs/USER_GUIDE.md)（待生成）

## 注意事项

⚠️ **模型文件需要单独下载**，项目本身不包含模型权重  
⚠️ **首次构建索引耗时较长**，请耐心等待  
⚠️ **CPU 推理速度较慢**，生成回答预计需要 15-60 秒

## License

MIT