Skip to content

Commit 4deabf5

Browse files
author
Tonny@Home
committed
doc: add description about market setting in models
1 parent a09e8d4 commit 4deabf5

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

docs/01_TRAINING_GUIDE.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,16 @@ models:
5656
gru: # 模型唯一标识名
5757
algorithm: gru # 算法名称
5858
dataset: Alpha158 # 数据处理器
59-
market: csi300 # 目标市场
59+
market: csi300 # 目标市场(作为元数据标签用于命令行筛选)
6060
yaml_file: config/workflow_config_gru.yaml # Qlib 工作流配置
6161
enabled: true # 是否参与全量训练
6262
tags: [ts] # 分类标签(用于筛选)
6363
notes: "可选备注" # 备注信息
6464
```
6565
66+
> [!NOTE]
67+
> **关于市场配置的区别**:注册表中的 `market` 字段是**模型元数据标签**,专门用于在执行增量训练或预测时通过 `--market` 参数进行筛选过滤。实际拉取量价数据时,系统依据的是 `model_config.json` 中的全局 `market` 设置。
68+
6669
### 添加新模型
6770

6871
1. 创建 YAML 工作流配置 `config/workflow_config_xxx.yaml`

docs/en/01_TRAINING_GUIDE.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,16 @@ models:
5656
gru: # Model unique identifier
5757
algorithm: gru # Algorithm name
5858
dataset: Alpha158 # Data handler
59-
market: csi300 # Target market
59+
market: csi300 # Target market (Metadata tag used for CLI filtering)
6060
yaml_file: config/workflow_config_gru.yaml # Qlib workflow config
6161
enabled: true # Whether to participate in full training
6262
tags: [ts] # Classification tags (for filtering)
6363
notes: "Optional notes" # Notes
6464
```
6565
66+
> [!NOTE]
67+
> **Distinction of Market Configurations**: The `market` field in the registry acts strictly as a **Model Metadata Tag** intended for CLI selection filtering via `--market` during incremental training or predictions. Actual data extraction bounds are perpetually steered by the global `market` setting inside `model_config.json`.
68+
6669
### Adding a New Model
6770

6871
1. Create a YAML workflow config at `config/workflow_config_xxx.yaml`

0 commit comments

Comments
 (0)