表达式转代码工具
在本人新推出polars_ta这个库后,再回头反思expr_codegen
是什么。
expr_cdegen
本质是DSL
,领域特定语⾔(Domain Specific Language)。但它没有定义新的语法
它解决了两个问题:
polars_ta
已经能很方便的写出特征计算表达式,但遇到混用时序与截面
的表达式,利用expr_codegen
能自动分组大大节省工作expr_codegen
利用了Common Subexpression Elimination
公共子表达式消除,大量减少重复计算,提高效率
就算在量化领域,初级研究员局限于时序指标,仅用polars_ta
即可,中高级研究员使用截面指标,推荐用expr_codegen
虽然现在此项目与polars_ta
依赖非常紧密,但也是支持翻译成其它库,如pandas / cudf.pandas
,只是目前缺乏一个比较简易的库
https://exprcodegen.streamlit.app
初级用户可以直接访问此链接进行表达式转译,不需要另外安装软件。(此工具免费部署在国外,打开可能有些慢)
更完整示例访问alpha_examples
运行demo_cn.py
生成output.py
,将此文件复制到其它项目中直接import
使用即可。一般生成的文件不需要再修改。
│ requirements.txt # 通过`pip install -r requirements.txt`安装依赖
├─data
│ prepare_date.py # 准备数据
├─examples
│ alpha101.txt # WorldQuant Alpha101示例,可复制到`streamlit`应用
│ demo_cn.py # 中文注释示例。演示如何将表达式转换成代码
│ demo_exec_pl.py # 演示调用转换后代码并绘图
│ output.py # 结果输出。可不修改代码,直接被其它项目导入
│ show_tree.py # 画表达式树形图。可用于分析对比优化结果
│ sympy_define.py # 符号定义,由于太多地方重复使用到,所以统一提取到此处
├─expr_codegen
│ │ expr.py # 表达式处理基本函数
│ │ tool.py # 核心工具代码。一般不需修改
│ ├─polars
│ │ │ code.py # 针对polars语法的代码生成功能
│ │ │ template.py.j2 # `Jinja2`模板。用于生成对应py文件,一般不需修改
│ │ │ printer.py # 继承于`Sympy`中的`StrPrinter`,添加新函数时可能需修改此文件
本项目依赖于sympy
项目。所用到的主要函数如下:
simplify
: 对复杂表达式进行化简cse
:Common Subexpression Elimination
公共子表达式消除StrPrinter
: 根据不同的函数输出不同字符串。定制此代码可以支持其它语种或库
因为groupby
,sort
都比较占用时间。如果提前将公式分类,不同的类别使用不同的groupby
,可以减少计算时间。
ts_xxx(ts_xxx)
: 可在同一groupby
中进行计算cs_xxx(cs_xxx)
: 可在同一groupby
中进行计算ts_xxx(cs_xxx)
: 需在不同groupby
中进行计算cs_xxx(ts_xxx(cs_xxx))
: 需三不同groupby
中进行计算gp_xxx(aa, )+gp_xxx(bb, )
: 因aa
,bb
不同,需在两不同groupby
中进行计算
所以
- 需要有一个函数能获取当前表达式的类别(
get_current
)和子表达式的类别(get_children
) - 如果当前类别与子类别不同就可以提取出短公式(
extract
)。不同层的同类别表达式有先后关系,不能放同一groupby
- 利用
cse
的特点,将长表达式替换成前期提取出来的短表达式。然后输入到有向无环图(DAG
) - 利用有向无环图的流转,进行分层。同一层的
ts
,cs
,gp
不区分先后 - 同一层对
ts
,cs
,gp
分组,然后生成代码(codegen
)即可
隐含信息
ts
: sort(by=[ASSET, DATE]).groupby(by=[ASSET], maintain_order=True)cs
: sort(by=[DATE]).groupby(by=[DATE], maintain_order=False)gp
: sort(by=[DATE, GROUP]).groupby(by=[DATE, GROUP], maintain_order=False)
即
- 时序函数隐藏了两个字段
ASSET, DATE
,横截面函数了隐藏了一个字段DATE
- 分组函数转入了一个字段
GROUP
,同时隐藏了一个字段DATE
两种分类方法
- 根据算子前缀分类(
get_current_by_prefix
),限制算子必需以ts_
、cs_
、gp_
开头 - 根据算子全名分类(
get_current_by_name
), 不再限制算子名。比如cs_rank
可以叫rank
- 备份后编辑
demo_cn.py
,import
需要引入的函数 - 然后
printer.py
有可能需要添加对应函数的打印代码- 注意:需要留意是否要加括号
()
,不加时可能优先级混乱,可以每次都加括号,也可用提供的parenthesize
简化处理
- 注意:需要留意是否要加括号
- 还有很多函数没有添加,需要大家提交代码一起完善
- 目前表达式样式优先向WorldQuant 的 Alpha101 靠齐
-
sympy
不支持==
,而是当成两个对象比较。例如:if_else(OPEN==CLOSE, HIGH, LOW)
, 一开始就变成了if_else(False, HIGH, LOW)
- 可以用
Eq
来代替,if_else(Eq(OPEN, CLOSE), HIGH, LOW)
。具体示例请参考Alpha101
中的alpha_021
-
sympy
不支持bool
转int
。例如:(OPEN < CLOSE) * -1
报错TypeError: unsupported operand type(s) for *: 'StrictLessThan' and 'int'
- 可以用
if_else
代替。if_else(OPEN<CLOSE, -1, 0)
。具体示例请参考Alpha101
中的alpha_064
需要转译的部分公式,详细代码请参考 Demo
exprs_src = {
"expr_1": -ts_corr(cs_rank(ts_mean(OPEN, 10)), cs_rank(ts_mean(CLOSE, 10)), 10),
"expr_2": cs_rank(ts_mean(OPEN, 10)) - abs_(log(ts_mean(CLOSE, 10))) + gp_rank(sw_l1, CLOSE),
"expr_3": ts_mean(cs_rank(ts_mean(OPEN, 10)), 10),
"expr_4": cs_rank(ts_mean(cs_rank(OPEN), 10)),
"expr_5": -ts_corr(OPEN, CLOSE, 10),
}
转译后的代码片段,详细代码请参考Polars版
def func_0_ts__asset(df: pl.DataFrame) -> pl.DataFrame:
df = df.sort(by=[_DATE_])
# ========================================
df = df.with_columns(
_x_0=1 / ts_delay(OPEN, -1),
LABEL_CC_1=(-CLOSE + ts_delay(CLOSE, -1)) / CLOSE,
)
# ========================================
df = df.with_columns(
LABEL_OO_1=_x_0 * ts_delay(OPEN, -2) - 1,
LABEL_OO_2=_x_0 * ts_delay(OPEN, -3) - 1,
)
return df
转译后的代码片段,详细代码请参考Pandas版
def func_2_cs__date(df: pd.DataFrame) -> pd.DataFrame:
# expr_4 = cs_rank(x_7)
df["expr_4"] = (df["x_7"]).rank(pct=True)
return df
def func_3_ts__asset__date(df: pd.DataFrame) -> pd.DataFrame:
# expr_5 = -ts_corr(OPEN, CLOSE, 10)
df["expr_5"] = -(df["OPEN"]).rolling(10).corr(df["CLOSE"])
# expr_6 = ts_delta(OPEN, 10)
df["expr_6"] = df["OPEN"].diff(10)
return df
df = df.sort_values(by=["asset", "date"]).groupby(by=["asset"], group_keys=False).apply(func_0_ts__asset__date)
df = df.groupby(by=["date"], group_keys=False).apply(func_0_cs__date)
df = func_0_cl(df)
只需运行streamlit run streamlit_app.py