Publish verified Quant Lab dataset manifest and guide

README.md

@@ -0,0 +1,101 @@
+---
+language:
+  - zh
+tags:
+  - finance
+  - quant-lab
+  - parquet
+  - a-share
+configs:
+  - config_name: daily_features
+    data_files:
+      - split: train
+        path: features/daily_features.parquet
+  - config_name: margin_summary
+    data_files:
+      - split: train
+        path: margin/summary/**/*.parquet
+---
+
+# Quant Lab · 共享行情数据
+
+配套代码：[yanlutao-scut/quant-lab](https://github.com/yanlutao-scut/quant-lab)。
+本仓库保存可下载的行情快照，数据源为 NumCat；下载接口返回值经过脚本解析、校验并转成 Parquet。
+本仓库不授予原始行情的额外使用或转售许可，使用及共享范围以数据源授权为准。
+
+## 内容与覆盖范围
+
+本次完整快照约 **6.01 GB / 15,054 个数据文件**（另含说明与校验清单）：
+
+| 数据 | 日期覆盖 | 记录数 |
+| --- | --- | ---: |
+| 全市场日线 | 2024-07-15 至 2026-09-08，524 个交易日 | 2,842,159 |
+| 复权行情与因子 | 2024-07-15 至 2026-09-08，524 个交易日 | 2,914,488 |
+| 两融证券明细 | 2025-08-27 至 2026-09-07，250 个交易日 | 1,079,096 |
+| 已下载逐笔 | 42 只股票，80 个不同交易日，区间内并非每日均覆盖 | 401,835,082 |
+| 资金日指标 | 43 只股票，不同股票的历史长度不同 | 3,393 |
+
+逐笔日期最早 2026-01-05、最晚 2026-07-24；该首尾范围内存在未覆盖日期，不能按连续半年理解。
+详细文件级覆盖与 SHA-256 见 `dataset_manifest.json`。
+
+| 目录 | 内容 |
+| --- | --- |
+| `market/` | 全市场日线、成交量额、后复权 OHLC、复权因子与估值字段 |
+| `margin/` | 交易所两融汇总和证券两融明细 |
+| `raw/trades/` | 已下载股票/日期的逐笔原始字段，每页转为 Parquet；不代表全市场逐笔完整覆盖 |
+| `features/daily_features.parquet` | 从本地指标表单独导出的资金日指标，保留因子与数据版本 |
+| `reference/` | 股票代码、名称目录缓存 |
+| `dataset_manifest.json` | 本次完整快照的文件列表、SHA-256、行数、容量与日期覆盖 |
+
+行情、两融和资金指标的覆盖范围不同，以清单为准；新上市/停牌/退市等原因可能造成个股日期缺失。
+逐笔只保留下载时请求的字段，不包含账户或席位身份；不能据此识别同一账户。
+没有包含个人 SQLite、策略定义、标注、回测记录、API Key、日志或运行锁。
+预览器中的 `train` 只是文件集合名称，不表示已经划分训练集/测试集。
+
+## 接入 Quant Lab
+
+在代码仓库的 `numcat_active_buy/` 下配置 `.env`：
+
+```dotenv
+APP_DATA_DIR=/你的本地数据目录
+HF_TOKEN=<your-hf-token>
+HF_DATASET_REPO=lutaoyan/quant-data
+```
+
+安装 `uv sync --locked --extra data-sync`。首次下载可执行下面的 Python 代码；
+`REVISION` 推荐填本仓库某个已完成快照的 commit SHA，避免下载期间版本变化。
+
+```python
+from app.config import Settings
+from huggingface_hub import HfApi, snapshot_download
+
+settings = Settings.from_env()  # 同时加载本机 .env
+repo = "lutaoyan/quant-data"
+revision = HfApi().repo_info(repo, repo_type="dataset").sha
+snapshot_download(repo, repo_type="dataset", revision=revision,
+                  local_dir=settings.data_dir,
+                  allow_patterns=["market/**", "margin/**", "raw/**", "features/**",
+                                  "reference/**", "dataset_manifest.json"])
+```
+
+在下载完成后（将校验目录替换成自己的数据总路径）：
+
+```bash
+uv run --extra data-sync python scripts/share_hf_data.py verify --directory /你的本地数据目录
+uv run --extra data-sync python scripts/share_hf_data.py import-features
+make setup
+make run
+```
+
+导入只增加本机没有的指标行，保留已有指标、策略与标注。下载会更新同名共享行情文件；
+请先停止本地行情更新任务，迁移到已有环境时保留备份。
+只做日线研究时可以移除 `raw/**`，节省大部分下载量；完整清单校验会提示未下载逐笔，属预期。
+
+## 后续发布与版本
+
+由一台主机更新 NumCat 数据，执行 `make data-prepare`，再执行 `make data-push`。
+本仓库为公开仓库，发布者已确认可公开共享；上传时需显式执行
+`make data-push HF_UPLOAD_FLAGS=--allow-public`。私有仓库不需要这个参数。
+脚本按白名单准备独立副本，上传数据后核对远端文件，再发布完整清单；可中断重跑。
+快照发布包含多次提交，**以发布清单的最终提交作为可使用版本**，不要选择上传中间提交。
+已有文件可能被更新，旧版本可以通过 commit SHA 下载；多个协作者各自保留自己的 SQLite。