快速上手之因子开发

因子模块通常是一个类型的因子集合。

属性：因子的计算类型及频率，通常会与因子计算模板的属性匹配进行推荐；

标签：可以自定义标签，对因子进行分类；

备注：记录因子的使用方法或实现思路等。

因子通常表示为数学公式，因子代码开发的过程是使用 DolphinScript 实现该公式，因此本平台支持使用DolphinScript的内置函数，包括聚合算子以及滑动窗口函数等。

此外，编辑页面提供了丰富的代码开发功能。包括函数高亮，内置函数的语法及描述，同时也支持追踪最近五条保存的历史记录。

当部分复杂因子需要自定义函数时，有两种方法：

方法一：将自定义函数存储在公共脚本库下的函数模块库中。例如将算子helperFunction1(a,b)代码存入了 helperFunction 模块中。因子代码中以helperFunction::helperFunction1(a,b)的形式调用该函数；该方法适用于对所有用户公开代码及公开使用的函数。

方法二：将自定义函数存储在该因子模块的第一位。如图所示，同一模块下的因子可以使用该算子。该方法适用于用户需要自定义算子，但不希望公开该代码。

计算模板是将因子代码代入数据计算的过程，因此计算模板可适配于多个数据源或者多个同类型的因子计算。

属性：因子模板的计算类型及频率，通常会与因子的属性匹配，进行推荐；

标签：可以自定义标签，对因子模板进行分类；

备注：记录因子模板的使用方法或实现思路等。

因子计算模板仅支持一个函数定义，如有自定义辅助函数请存储在公共脚本库下的函数模块库中使用。

在Starfish中，推荐用户使用元编程的方式开发因子计算模板。

以下为供开发参考的元编程模板。

def demo(data, factorName, factorParameter, startDate, endDate){
    // 因子计算模板参考
    // data: 数据源, TABLE
    // factorName: 计算的因子, STRING
    // factorParameter: 因子函数入参参数, STRING
    // startDate, endDate: 计算起止时间, DATE

    //step1: 处理因子入参参数，生成元编程列
    args = ((factorParameter.strReplace(" ","")).split(","))
    args = each(sqlCol, args)

    //step2: 生成元编程select
    selects = (
        sqlCol( `tradetime), 
        sqlCol(`securityid),
        sqlColAlias(makeUnifiedCall(funcByName("string"), factorName), "factorname"),
        sqlColAlias(makeUnifiedCall(funcByName(factorName), args),"value"))
    
    //step3: 指定数据库与表
    from_tb = data

    //step4: 生成元编程whereCondition
    whereConditions = expr(startDate, <=, sqlCol(`tradetime), <=, endDate)

    //step5: 生成sql语句并执行
    ret = sql(
        select = selects,
        from = from_tb,
        where = whereConditions)
    return ret.eval()
}

此处模板调用因子函数的方法：通过将因子名作为参数，模板内部调用因子。

• 需要有参数为因子函数的名称，例如factorName。

• 以funcByName获取因子函数定义，再通过makeUnifiedCall来使用指定参数args调用该因子函数并生成脚本，可参考代码中step 2。

• 最后返回一个tradetime, securityid, factorName, value四列的表格。

Starfish自带四种常用的计算模板，分别为sql_without_group_by, sql_with_group_by, prepData, panel_call，具体代码及参数使用请在平台内查看。

• sql_without_group_by: 该模板适用于中高频的数据，以SQL的方式调用因子模块代码，不涉及group by分组。支持列名映射。

• sql_with_group_by: 该模板适用于中高频的数据，以SQL的方式调用因子模块代码，对时间列聚合成天后，与股票列进行分组计算。支持列名映射。

• prepData: 该模板适用于低频的数据，对列名映射后，与panel_call模板配合使用。

• panel_call: 该模板适用于低频的数据，将数据转置成面板数据后进行计算。不支持列名映射。

因子评价模板代码的开发方式与因子计算模板相同，均为一个函数形式调用。

以 alphalensMain 为例：

def alphalensMain(factorResult, 
    priceTable, priceDate, startDate, endDate, priceSymbol, priceCol,
    quantile=5,
    period="1,5,10", 
    filter_zscore=20, 
    max_loss=0.35, 
    zero_aware=false, 
    cumulative_returns=true, 
    long_short=true) {
        
    factor = select tradetime, securityid, value from factorResult

    // prices
    whereConditions = expr(startDate, <=, sqlCol(priceDate), <=, endDate)
    pivotBy = [sqlColAlias(sqlCol(priceDate), `date), sqlCol(priceSymbol)]
    prices = sql(
          select=sqlCol(priceCol), 
          from=priceTable, 
          where=whereConditions, 
          groupBy=pivotBy, 
          groupFlag=2
          ).eval();

    //Empty groupby or groupby_labels
    groupby = NULL
    groupby_labels = NULL
    binning_by_group=false
    group_neutral=false
    by_group=false

    //quantiles
    quantiles = int(quantile)
    bins = NULL

    //periods
    periods = int(period.split(","))

    // alpahlens
    dicts = alphalens::plot_factorAnalysis(
            factor=factor, 
            prices=prices, 
            groupby=groupby,
            binning_by_group=binning_by_group,
            quantiles=quantiles,
            bins=bins,
            periods=periods,
            filter_zscore=filter_zscore,
            groupby_labels=groupby_labels,
            max_loss=max_loss,
            zero_aware=zero_aware,
            cumulative_returns=cumulative_returns,
            long_short=long_short,
            group_neutral=group_neutral,
            by_group=by_group
            )

    // res: key+table
    res = alphalens::extract_result_tables(dicts)

    return res
}

• 评价模板名称应与其函数名称相同。

• 辅助函数应放置于函数模块库中，alphalens相关代码也可在函数模块库中查看，以alphalens::plot_factorAnalysis形式调用。

• 结果需要返回为一个字典，可以包含多张表。其中key为表名，value为表格内容。

同因子计算模板，评价模板需要使用者输入参数值。

以下是对alphalensMain模板参数的数据类型及含义解释：

因子评价模板的结果为字典形式时，可以配合使用可视化模板，生成可视化报告，方便用户对于因子表现有更为直观的方式。Alphalens的评价方法同时也配备了内置的可视化模板。

• 因子发布时，可以选择其生成的评价报告提供给审批人查阅。

• 支持对因子代码进行加密，公开后，他人无法查看因子代码，仅能使用该因子进行计算。

• 因子审批的相关消息会同步通知，请查阅右上角的消息按钮。

平台内已内置7个公开因子模块，分别为：

• alpha101: 101 Formulaic Alphas 论文中给出的世界顶级量化对冲基金 WorldQuant 所使用的 101 个因子公式。

• alpha191: 国泰君安 191 Alpha 因子，来源于国泰君安在2017 年 6 月份公布的研报《基于短周期价量特征的多因子选股体系——数量化专题之九十三》，属于短周期价量因子。

• common: 常用的三个因子

• mytt: MyTT指标库，来源于My麦语言、T通达信、T同花顺的指标公式，实现的常见指标包括MACD、RSI、BOLL、ATR、KDJ、CCI、PSY等。

• snapshot: snapshot数据常用的高频因子

• ta: 技术分析（Technical Analysis）指标库

• tick: tick级别数据常用的高频因子

内置的公共因子计算模板库已在上文讲解，不再赘述。

上线因子通常需要对每日数据进行计算后入库，本平台支持对因子计算任务进行定时设置。

步骤一：创建

选择【工作流】-【创建】后，配置好任务参数。

本平台内置中、高、低频的三个因子库，列名为username, tradetime, securityid, factorname, value。因子计算模板需要返回tradetime, securityid, factorname, value四列，入库时系统会自动加上username列。

此外，用户同时也可以选择自己的库表写入，因子计算模板返回的内容，应与库表格式一致。

步骤二：定时设置

返回列表，对该工作流进行定时设置。执行频率可以为月、周、天，频率必须间隔5分钟。

如果已有日频数据，可跳过本节。

步骤一：进入数据管理 - 数据导入 - 找到kDaySimu模板

步骤二：点击【运行】

步骤三：填写参数

注:

• dbName请勿与现有库名重复

• dbName请以dfs://开头

• 如果非admin账户，dbName需要以自己有权限的命名开头

• numOfYear从2010年开始模拟，图中为模拟3年数据，2010.01.01 - 2012.12.31

完成后，点击【确认】

步骤四：确认导入状态

成功即可进入下一节，失败请删除库表后重试。

步骤一：进入因子与评价 - 我的因子 - 点击【创建】

步骤二：填写新因子相关信息

• *为必填项目，只需填写因子模块名称即可

• 完成后，点击【确定】按钮

步骤三：进入因子代码编辑页面

• 默认会提供World Quant Alpha101中的41因子和101因子代码。在World Quant Alpha101 中，大多数因子计算都涉及横向与纵向的计算。但非行业因子中的41、101号因子等除了可以用矩阵入参之外，也可以向量入参用 SQL 调用。

步骤一：点击【测试】 - 填写参数

步骤二：选择因子：可同时选择一个模块下多个因子进行计算

步骤三：模板参数配置

1. 选择模板 - sql_without_groupby，该模板将直接对数据进行计算，不进行group by分组。

2. 填写参数：填写 3.1中创建的库表，如为其他数据库，则选择对应库名

3. 填写完成后点击【保存预设】，方便下次使用。

步骤四：点击【确定】，开始计算

注： 如果为自己的库表，需要进行列名映射：

oriName 为表中的列名，tarName 为因子中的列名 open, close, high, low 等；

需要指定标的列名 securityidName 以及交易时间列名 tradetimeName。

步骤五：查看运行结果 - 点击【查看】

图中为WQAlpha101的计算结果，value列为因子值。

注：该结果为临时数据，并未落库，如果需要入库请在工作流中设置任务，计算后入库。

步骤一：点击【生成评价报告】 - 选择alphalensMain

步骤二：填写参数

步骤三：结果解释

运行成功后，会出现数据结果，如果需要查看可视化信息，请点击【查看可视化报告】

报告主要分为四个部分：描述性统计，信息系数(IC)分析，收益分析，换手率分析。图中为模拟数据，可能出现异常值。

1. 描述性统计

   观察因子在不同分组下的分布

   

2. IC 分析

   IC (信息系数, Information Coefficient) 是衡量因子预测力的一个核心指标，反映了因子值与实际收益之间的相关性。一个有效的因子，应当具备较高的 IC 绝对值，并能在一段时间内保持 IC 的持续性和稳定性。这里我们绘制了 IC 分析的相关图表，如 IC 时间序列、月度 IC 均值等。

   通过对上述一系列 IC 分析图表的综合分析，我们可以较为全面地评估该因子的预测力和有效性，判断其是否值得信赖和持续投资。例如，如果一个因子在长期内保持着较高且稳定的 IC 水平，那它就很可能是一个值得重视的有效因子。

   

3. 收益分析

   收益分析，是单因子评估过程中最为核心和关键的一个环节。本报告生成一组全面的因子收益分析图表，包括不同持仓期内的累计收益率走势、按分位数分组的收益分布等。有了这些丰富的视觉呈现，我们就可以对因子的盈利能力有更直观的感受，并分析其在不同市场环境下的表现，为投资策略的进一步优化提供方向，如挖掘其表现最佳的持仓期限、结合不同市场环境作出调整等。

   

4. 换手率分析

   投资组合的换手率是评估交易活跃程度和执行成本的一个重要指标。高换手率意味着更频繁的交易，从而带来更高的交易成本和潜在的负面冲击。而低换手率则可能导致投资组合无法及时调整，错失获利机会。报告生成换手率分析的可视化图表，展示不同持仓期下的组合平均换手率、分位数换手率等数据，帮助我们评估因子的交易活跃程度和执行成本。