# world-quant-brain

**Repository Path**: xiegengcai/world-quant-brain

## Basic Information

- **Project Name**: world-quant-brain
- **Description**: No description available
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 0
- **Created**: 2025-04-15
- **Last Updated**: 2026-01-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# world-quant-brain

## 介绍
world-quant-brain 是一个用于[WorldQuantBRAIN](https://platform.worldquantbrain.com/)量化金融研究的工具集，专注于生成、测试和提交alpha因子。该项目旨在帮助用户发现具有潜在盈利能力的交易信号，并通过一系列验证步骤确保其稳健性。

## 使用说明

### 主要组件

#### `Generator`
生成alpha因子的工厂类，支持多种生成策略。


#### `Simulator`
模拟alpha因子的表现，评估其在实际交易中的潜力。

#### `Checker`
提供对alpha因子的本地和服务器端检查功能，确保其符合质量标准。

#### `Submitter`
提交经过验证的alpha因子到服务器，支持异步提交和失败重试机制。

#### `ExportFiles`
导出数据集、操作符和alpha因子信息到文件中，便于分享和存档。

#### `RobustTester`
用于对alpha因子进行稳健性测试。主要功能包括定位alpha因子、构建模拟数据列表、获取alpha数据、绘制结果图表以及运行测试。

### 安装依赖
确保安装了以下依赖：
```bash
pip install -r requirements.txt
python main.py
```
### 运行流程
```mermaid
sequenceDiagram
    autonumber
    actor user
    participant Generator
    participant factory as Factory
    participant s as Simulator
    participant sync as 同步器
    participant Checker
    participant Submitter
    participant db as SQLite
    participant wq as WorldQuant BRAIN

    user->>Generator: python generator.py
    Generator->>factory: 生成Alpha
    factory-->>Generator: 返回Alpha
    Generator->>db: 保存Alpha

    user->>+s: python simulator.py
    s->>+db: 查询待回测Alpha
    db->>-s: 返回待回测Alpha
    s->>+wq: 回测Alpha
    wq -->>-s: 返回回测结果
    s->>db: 更新Alpha状态

    user ->>+sync: python sync.py
    sync->>+db: 查询待同步Alpha
    db->>-sync: 返回待同步Alpha
    sync->>+wq: 同步Alpha
    wq -->>-sync: 返回同步结果
    sync->>db: 更新Alpha指标数据

    user->>+Checker: python checker.py
    Checker->>+db: 查询待检查Alpha
    db->>-Checker: 返回待检查Alpha
    Checker->>+wq: 检查Alpha
    wq -->>-Checker: 返回检查结果
    Checker->>db: 更新Alpha状态

    user ->>+Submitter: python submitter.py
    Submitter->>+db: 查询待提交Alpha
    db->>-Submitter: 返回待提交Alpha
    Submitter->>+wq: 提交Alpha
    wq -->>-Submitter: 返回提交结果
    Submitter->>db: 更新Alpha状态
```

### 贡献指南
欢迎贡献代码和文档。请遵循以下步骤：
1. Fork 项目。
2. 创建新分支。
3. 提交更改。
4. 创建 Pull Request。

### 许可证
该项目遵循 MIT 许可证。详情请查看 LICENSE 文件。