docs: 同步 README/USAGE 至 M6–M8(选股系统主线 + MySQL + 新 API/Agent 工具/限制)

- README:架构分层示意(Selection/Signal/Portfolio/Composite Engine)、MySQL 默认配置、
  核心能力表、里程碑 M0–M8
- USAGE:概览模块与页面清单、引擎分层 §6.0、API 表新增 /api/selections /api/signals
  /api/strategies /api/composites、Agent 10 工具、已知限制(M8.4 延后/全市场选股同步耗时)
This commit is contained in:
Simon
2026-09-09 06:29:51 +08:00
parent db147c4232
commit 314bfc159f
2 changed files with 91 additions and 41 deletions
+40 -18
View File
@@ -1,6 +1,6 @@
# qlib-platform
个人 A 股量化研究平台:**选股 · 因子研究 · 回测**,面向低频 / 中低频交易研究。
个人 A 股量化研究平台:**股票筛选 · 因子研究 · 交易信号 · 选股回测**,面向低频 / 中低频交易研究。
> 核心量化引擎:[Qlib](https://github.com/microsoft/qlib) · 首选数据源:Tushare(新浪财经为备用)· 当前数据库:MySQL(业务层无感切换;SQLite 仅兜底)
@@ -16,13 +16,17 @@
详见 [AGENT.md](./AGENT.md)(开发约束)与 [docs/ARCHITECTURE.md](./docs/ARCHITECTURE.md)(架构文档),**改代码前必须阅读**。
```text
Web 前端 (frontend/web)
↓ REST / SSE
FastAPI (backend)
↓ Research Specification
Application Service ── Quant Service ── Qlib Adapter ── Qlib
↓ ↓
Repository / DAO Parquet / MySQL
Web 前端 (frontend/web:总览 / 股票池 / 股票筛选 / 因子研究 / 因子组合 / 交易信号 / 选股回测 / 实验)
↓ REST / SSE(异步 Job 状态机)
FastAPI (backend:业务对象 API,见下「核心能力」)
↓ Research Specification(统一研究契约)
Application Service(SelectionService / SignalService / ResearchService / Strategy …)
├── Selection Engine(条件选股 / 因子评分 / as_of 历史与当前一致)
├── Signal Engine(BUY / WATCH / SELL + 理由)
├── Portfolio Engine(等权;约束预留并如实标注)
└── Quant Service ── Composite Engine ── Qlib Adapter ── Qlib
↓ ↓
Repository / DAO MySQL(默认)/ Parquet
```
### 目录结构
@@ -35,7 +39,8 @@ qlib/
│ │ ├── application/ # 用例 / 应用服务(编排,不含框架细节)
│ │ ├── domain/ # 领域实体 + Repository Protocol
│ │ ├── infrastructure/ # SQLAlchemy / Alembic 等基础设施实现
│ │ ├── quant/qlib_adapter/ # Qlib 适配层(业务禁止直接 import qlib)
│ │ ├── quant/ # 因子 / composite / universe / selection / signal / portfolio 引擎
│ │ │ └── qlib_adapter/ # Qlib 适配层(业务禁止直接 import qlib)
│ │ ├── agent/ # AI Research Agent(Phase 5,仅 Tool 访问)
│ │ └── core/ # 配置、通用组件
│ └── tests/
@@ -75,21 +80,38 @@ uv run uvicorn app.main:app --reload --port 8000
# 交互文档:http://127.0.0.1:8000/docs
```
### 数据库迁移(Alembic,已就位)
### 数据库(默认 MySQL)
- 连接在根目录 `config.yaml → database.mysql`(host/port/db/user/charset),密码放 `.env` 的
`MYSQL_PASSWORD`;URL 优先级:`DATABASE_URL` 环境变量 > `database.mysql` > SQLite 兜底。
- 结构变更(Model → Migration → Test):
```bash
cd backend
uv run alembic upgrade head # 首次运行会在 data/quant.db 建立版本表
uv run alembic revision --autogenerate -m "add xxx table" # 修改 Model 后生成迁移
uv run alembic upgrade head # 在当前配置指向的库上建表(默认 MySQL qlib)
uv run alembic revision --autogenerate -m "add xxx table"
```
## 开发阶段(对应架构文档 §20)
## 核心能力(现状)
- **Phase 1 数据**:Tushare → 标准化 → MySQL(stock / daily / 复权因子 / 交易日历 / 财务指标),Parquet 导出
- **Phase 2 Qlib**:Parquet → Qlib Dataset → 因子(Alpha158 / 自定义)→ LightGBM → 回测
- **Phase 3 Web**:股票池 / 因子研究 / 选股 / 回测 / 结果可视化(Next.js + ECharts)
- **Phase 4 Experiment**:所有研究自动可复现存档
- **Phase 5 AI Agent**:自然语言 → Research Plan → 受控 Tool → Experiment
| 能力 | 说明 / 入口 |
|---|---|
| 股票筛选 | `POST /api/selections`(A 条件选股 / B 因子评分 TopN,`as_of` 当前/历史,结果可解释可复现);Web `/selection` |
| 因子目录 | `factor_definition` 落库;`GET /api/factors`;组合可保存复用 `POST /api/composites` |
| 因子研究 | Job 异步 IC / RankIC / 分层测试(`/api/jobs`) |
| 交易信号 | `POST /api/signals`:评分排名 + 趋势规则 → BUY/WATCH/SELL + 理由;Web `/signals` |
| 选股回测 | `POST /api/backtests`(成本/涨跌停近似;与当前选股共用同一评分引擎,v2 §25 一致性) |
| 策略资产 | `strategy` 落库 + `/api/strategies`(命名配置,可展开为回测 spec) |
| Experiment | 每次研究自动归档 + 一键复跑 + SSE 进度 |
| AI Agent | `POST /api/agent/chat`,10 个受控 Tool(含 screen_stocks / explain_selection / generate_signals / create_strategy) |
## 里程碑(详见 [ROADMAP.md](./docs/ROADMAP.md) 与 [docs/DEV_PLAN_v2.md](./docs/DEV_PLAN_v2.md))
- **M0–M5**:工程骨架 → 数据层 → 研究引擎 → Web → Experiment/Job → AI Agent
- **M-DB**:SQLite 全量迁移 MySQL(config.yaml 配置化 + 迁移工具 + 一致性校验)
- **M6**:选股系统主线(Universe + Selection A/B + 落库/API + 回测共用 + Web)
- **M7**:因子层(因子定义入库 + Composite 模块化 + 行情口径显式化)
- **M8**:Signal / Portfolio / Strategy / Agent 工具 / Web 做实(M8.4 Qlib 模型选股按需延后)
## 约定速查