update

README.md

@@ -8,6 +8,8 @@
 ## 2. 因子平台demo
 http://192.168.1.125:8222
 
+[因子平台计算参数说明.md](因子平台/因子平台计算参数说明.md)
+
 
 ## 3.因子表
 

因子平台/因子平台计算参数说明.md

@@ -0,0 +1,58 @@
+
+# 因子平台
+
+## 计算参数说明
+![alt text](../images/image.png)
+
+### 1. 因子函数（Python 代码编辑器）
+
+用户需在编辑器中定义用于计算因子的 Python 函数。该函数作为切片计算函数，会在后台按交易日、标的等维度对数据进行切片后被重复调用。
+
+函数输入为当前切片对应的数据子集（如单日或单标的时间序列）
+
+平台负责外层切片、并行调度及结果汇总，用户仅需关注单个切片内的计算逻辑
+
+#### 函数输入要求
+
+trade_dt是必须的参数，代表交易日当日的日期。
+df开头的为数据DataFrame，数据库中目前可以用的：
+
+- df_stock_kline_1day：股票日频K线数据，包括open, high, low, close, vwap, volume, amount, AdjPreClose这几列。
+- df_cons_flag：股票分类表，包括is_bj,is_new120,is_st,csi1000,csi2000,csi300,csi500,csiall_std这几列。
+- df_stock_kline_1min：股票分钟频K线数据
+- 也有期货数据不过期货暂时无法进行因子评估
+
+#### 函数输出要求
+需为一维结果（Series），作为该切片下的因子值
+
+### 2. 计算日期
+
+用于指定因子计算的整体时间范围。
+
+起始日期：因子计算开始的交易日期
+
+结束日期：因子计算结束的交易日期
+
+平台将在该时间区间内，对每个交易日依次触发因子计算任务。
+
+### 3. 计算窗口列表
+
+计算窗口用于定义因子计算时所使用的历史窗口和未来窗口，常用于滚动计算或收益评估。
+
+起始索引：表示在当前切片数据中，向历史方向回看的窗口长度
+
+例如：20 表示使用当前时点向前 20 个时间步的数据进行计算
+
+结束索引：表示在当前切片数据中，向未来方向使用的数据窗口
+
+常用于收益或未来表现计算，如 0 表示不使用未来数据，-20代表向后 20 个时间步的数据进行计算
+
+用户可添加多个计算窗口，平台会对每个窗口配置分别执行计算。
+
+### 4. 因子类型
+
+用于指定因子输入数据的时间粒度或类型。分钟频会有日内的结果评估，指数这个选项还在开发中。
+
+例如：日频、分钟级、指数等
+
+分钟频建议计算窗口在5以内，以免切片数据太大。