多种方式运行策略¶
在策略开发过程中,每个人都会有不同的需求,比如
不同的时间周期进行回测,
想直接基于回测数据进行编程分析,或直接看一下收益结果。
想将回测好的策略直接用于实盘交易
不同的品种设置不同的风控标准
在设计 RQAlpha API 的时候,考虑到以上随时变化的需求,将这部分需要以参数方式的配置严格从代码层面剥离。同一份策略代码,通过启动策略时传入不同的参数来实现完全不同的策略开发、风控、运行和调优等的功能。
警告
我们提供了多种方式来配置策略参数,请务必理解参数配置的优先级顺序,以避免在设置参数的时候因为优先级搞错而导致设置无效的问题!
参数配置优先级:策略代码中配置 > 命令行传参 = run_file | run_code | run_func
函数传参 > 用户配置文件 > 系统默认配置文件
命令行运行¶
在命令行模式中,我们预先定义了常用的参数作为命令行的 option,您可以直接在控制台输入参数来配置 RQAlpha, 但并不是所有的参数都可以通过命令行来配置,如果有一些特殊的参数需要配置,请结合其他方式来配置您的策略。 当然您也可以扩展命令行,来实现您指定的命令行 option 选项。
此处列出一些常用 option 选项,完整的命令行 option 列表可以执行 rqalpha run -h
查询.
命令行参数¶
参数名缩写 |
参数名全称 |
说明 |
---|---|---|
-d |
- - data-bundle-path |
数据源所存储的文件路径 |
-f |
- - strategy-file |
启动的策略文件路径 |
-s |
- - start-date |
回测起始日期 |
-e |
- - end-date |
回测结束日期(如果是实盘,则忽略该配置) |
-mm |
- - margin-multiplier |
设置保证金乘数,默认为1 |
-a |
- - account |
设置账户类型及起始资金,比如股票期货混合策略,起始资金分别为10000, 20000 |
-fq |
- - frequency |
目前支持 |
-rt |
- - run-type |
运行类型, |
N/A |
- - resume |
在模拟交易和实盘交易中,RQAlpha支持策略的pause && resume,该选项表示开启 resume 功能 |
-l |
- - log-level |
选择日志的输出等级,有 |
N/A |
- - locale |
选择语言, 支持 |
N/A |
- - disable-user-system-log |
关闭用户策略产生的系统日志(比如订单未成交等提示) |
N/A |
- - enable-profiler |
启动策略逐行性能分析,启动后,在回测结束,会打印策略的运行性能分析报告,可以看到每一行消耗的时间 |
N/A |
- - config |
设置配置文件路径 |
-mc |
- - mod-config |
配置 mod ,支持多个。 |
N/A |
- - rqdatac |
配置 rqdatac 的用户名密码,以便使用扩展 API,如 :code:`username:password`(若您已使用 Ricequant 提供的配置脚本将 rqdatac 的 license 配置到环境变量中,则无需再传入该参数) |
系统内置 Mod Option 扩展¶
系统内置 Mod 也提供了启动参数的扩展,当您开启了对应的 Mod 时,即可使用。
这里列出一些常用的扩展 option,完整的可用选项亦可以通过执行 rqalpha run -h
查询。
参数名缩写 |
参数名全称 |
说明 |
---|---|---|
-bm |
- - benchmark |
Benchmark,如果不设置,默认没有基准参照 |
N/A |
- - report |
[sys_analyser]保存交易详情 |
-o |
- - output-file |
[sys_analyser]指定回测结束时将回测数据输出到指定文件中 |
-p |
- - plot |
[sys_analyser]在回测结束后,查看图形化的收益曲线 |
N/A |
- - no-plot |
[sys_analyser]在回测结束后,不查看图形化的收益曲线 |
N/A |
- - plot-save |
[sys_analyser]将plot的收益图以指定文件路径保存 |
N/A |
- - progress |
[sys_progress]开启命令行显示回测进度条 |
N/A |
- - no-progress |
[sys_progress]关闭命令行查看回测进度 |
N/A |
- - short-stock |
[sys_accounts]允许股票卖空 |
N/A |
- - no-short-stock |
[sys_accounts]不允许股票卖空 |
N/A |
- - signal |
[sys_simulation]开启信号模式,不进行撮合,直接成交 |
-sp |
- - slippage |
[sys_simulation]设置滑点 |
-cm |
- - commission-multiplier |
[sys_simulation]设置手续费乘数,默认为1 |
-me |
- - match-engine |
[sys_simulation]启用的回测引擎,目前支持 |
-r |
- - rid |
[sys_simulation]可以指定回测的唯一ID,用户区分多次回测的结果 |
传递 Mod 参数¶
另外,部分可用的 mod 配置项没有直接暴露出命令行选项,对于这类参数,可以使用 -mc
进行设置,如:
-mc sys_accounts.auto_switch_order_value True
开启股票下单接口资金不足时自动使用全部剩余资金下单的功能
rqalpha run -rt p -fq 1m -f strategy.py --account stock 100000 -mc sys_accounts.auto_switch_order_value True
系统内置 mod 的可用配置项可以通过访问 mod 的 readme 页面查看,以下是目前已经集成的 Mod 列表:
Mod |
说明 |
---|---|
股票分红退市、下单等行为的控制,股票期货的风控选项 |
|
回测后输出图片、记录文件等行为的控制;策略 benchmark 的控制 |
|
策略运行过程中显示的进度条的控制 |
|
策略前端风控选项 |
|
回测、模拟交易中撮合行为的选项 |
|
回测,模拟交易中税费的控制 |
通过 Mod 自定义扩展命令行参数¶
RQAlpha 非常灵活,您可以在您的 Mod 中扩展命令行,我们以 sys_analyser Mod 添加自定义option --plot
来实现展示收益图为例,来介绍以下如何扩展您自己的命令行参数。
注解
rqalpha_mod_sys_analyser 对应源码请访问 这里 进行查看。
RQAlpha 使用 click 来实现命令行参数配置,您需要通过 click 来构建 option。
通过 from rqalpha import cli
来获取命令行对象。
import click
from rqalpha import cli
接下来我们命令 rqalpha run
中添加参数 --plot
来实现画图的功能
cli.commands['run'].params.append(
click.Option(
('-p', '--plot/--no-plot', 'mod__sys_analyser__plot'),
default=None,
help="[sys_analyser] plot result"
)
)
我们还希望可以通过 $ rqalpha plot result_pickle_file_path
来将之前通过pickle文件报错的某次回测的结果进行画图
@cli.command()
@click.argument('result_pickle_file_path', type=click.Path(exists=True), required=True)
@click.option('--show/--hide', 'show', default=True)
@click.option('--plot-save', 'plot_save_file', default=None, type=click.Path(), help="save plot result to file")
def plot(result_pickle_file_path, show, plot_save_file):
"""
[sys_analyser] draw result DataFrame
"""
import pandas as pd
from .plot import plot_result
result_dict = pd.read_pickle(result_pickle_file_path)
plot_result(result_dict, show, plot_save_file)
使用配置文件运行策略¶
在每次运行策略时,有一些参数是固定不变的,我们可以将不经常改变的参数写入配置文件。
RQAlpha 在运行策略时候会在当前目录下寻找 config.yml 或者 config.json 文件作为用户配置文件来读取。
创建 config.yml 配置文件¶
注解
我们假设在当前目录下存在 buy_and_hold.py 策略文件
# config.yml
base:
# 启动的策略文件路径
strategy_file: .buy_and_hold.py
# 回测起始日期
start_date: 2015-06-01
# 回测结束日期(如果是实盘,则忽略该配置)
end_date: 2050-01-01
# 目前支持 `1d` (日线回测) 和 `1m` (分钟线回测),如果要进行分钟线,请注意是否拥有对应的数据源,目前开源版本是不提供对应的数据源的。
frequency: 1d
# Benchmark,如果不设置,默认没有基准参照。
benchmark: ~
accounts:
# 设置 股票为交易品种 初始资金为 100000 元
stock: 100000
extra:
# 开启日志输出
log_level: verbose
mod:
sys_analyser:
enabled: true
# 开启 plot 功能
plot: true
当创建好 config.yml 文件后,执行 $ rqalpha run
即可运行策略。
创建默认配置文件模板¶
您可以通过该命令在当前目录下创建一份包含了 RQAlpha 基础配置项的全部参数默认值的模板文件。
$ rqalpha generate-config
# see more config
# http://rqalpha.readthedocs.io/zh_CN/stable/intro/run_algorithm.html
version: 0.1.6
# 白名单,设置可以直接在策略代码中指定哪些模块的配置项目
whitelist: [base, extra, validator, mod]
base:
# 数据源所存储的文件路径
data_bundle_path: ~
# 启动的策略文件路径
strategy_file: strategy.py
# 策略源代码
source_code: ~
# 回测起始日期
start_date: 2015-06-01
# 回测结束日期(如果是实盘,则忽略该配置)
end_date: 2050-01-01
# 设置保证金乘数,默认为1
margin_multiplier: 1
# 运行类型,`b` 为回测,`p` 为模拟交易, `r` 为实盘交易。
run_type: b
# 目前支持 `1d` (日线回测) 和 `1m` (分钟线回测),如果要进行分钟线,请注意是否拥有对应的数据源,目前开源版本是不提供对应的数据源的。
frequency: 1d
# 在模拟交易和实盘交易中,RQAlpha支持策略的pause && resume,该选项表示开启 persist 功能呢,
# 其会在每个bar结束对进行策略的持仓、账户信息,用户的代码上线文等内容进行持久化
persist: false
persist_mode: real_time
# 设置策略可交易品种,目前支持 `stock` (股票账户)、`future` (期货账户),您也可以自行扩展
accounts:
# 如果想设置使用某个账户,只需要增加对应的初始资金即可
stock: ~
future: ~
# 交易市场,如 cn 中国市场,hk 香港市场
market: cn
# 设置初始仓位
init_positions: {}
# 根据价格最小变动单位调整发单价格
round_price: false
# 用户自定义的期货合约数据,用于设置期货手续菲费率
future_info: {}
# 强平
forced_liquidation: true
extra:
# 选择日期的输出等级,有 `verbose` | `info` | `warning` | `error` 等选项,您可以通过设置 `verbose` 来查看最详细的日志,
# 或者设置 `error` 只查看错误级别的日志输出
log_level: info
# 通过该参数可以将预定义变量传入 `context` 内。
context_vars: ~
# enable_profiler: 是否启动性能分析
enable_profiler: false
is_hold: false
locale: zh_Hans_CN
logger: []
validator:
# close_amount: 在执行order_value操作时,进行实际下单数量的校验和scale,默认开启
close_amount: true
警告
生成的默认配置模板中不包含 Mod 相关的配置信息,每个 Mod 的配置信息请参考 Mod 对应的文档。
策略内配置参数信息¶
RQAlpha 提供了策略内配置参数信息的功能,您可以方便的在策略文件中配置参数,我们以 test_f_buy_and_hold 文件 为例来介绍此种策略运行方式。
# test_f_buy_and_hold.py
def init(context):
context.s1 = "IF88"
subscribe(context.s1)
logger.info("Interested in: " + str(context.s1))
def handle_bar(context, bar_dict):
buy_open(context.s1, 1)
__config__ = {
"base": {
"start_date": "2015-01-09",
"end_date": "2015-03-09",
"frequency": "1d",
"matching_type": "current_bar",
"benchmark": None,
"accounts": {
"future": 1000000
}
},
"extra": {
"log_level": "error",
},
"mod": {
"sys_progress": {
"enabled": True,
"show": True,
},
},
}
RQAlpha 会自动识别策略中的 __config__
变量。
警告
虽然 RQAlpha 提供了此种方式来配置策略,但主要用于自动化测试中对每个策略进行参数配置,不建议在策略开发和运行中使用此方式运行策略。
通过引用 RQAlpha 库在代码中运行策略¶
并不是所有业务场景下都需要使用 rqalpha run
命令行的方式来运行策略,您也可以在您的脚本/程序中直接运行 RQAlpha。
注解
即使通过代码方式启动策略,RQAlpha 也会寻找代码执行目录是否存在 config.yml / config.json 文件,作为用户配置文件来加载配置。但代码中传入的 config 优先级更高。
使用 run_file
函数来运行策略¶
此种模式下,您需要指定策略文件路径,并传入配置参数以启动策略
# run_file_demo
from rqalpha import run_file
config = {
"base": {
"start_date": "2016-06-01",
"end_date": "2016-12-01",
"benchmark": "000300.XSHG",
"accounts": {
"stock": 100000
}
},
"extra": {
"log_level": "verbose",
},
"mod": {
"sys_analyser": {
"enabled": True,
"plot": True
}
}
}
strategy_file_path = "./buy_and_hold.py"
run_file(strategy_file_path, config)
使用 run_code
函数来运行策略¶
此种模式下,您需要以字符串的方式传入策略源码,并传入配置参数以启动策略
# run_code_demo
from rqalpha import run_code
code = """
from rqalpha.api import *
def init(context):
logger.info("init")
context.s1 = "000001.XSHE"
update_universe(context.s1)
context.fired = False
def before_trading(context):
pass
def handle_bar(context, bar_dict):
if not context.fired:
# order_percent并且传入1代表买入该股票并且使其占有投资组合的100%
order_percent(context.s1, 1)
context.fired = True
"""
config = {
"base": {
"start_date": "2016-06-01",
"end_date": "2016-12-01",
"benchmark": "000300.XSHG",
"accounts": {
"stock": 100000
}
},
"extra": {
"log_level": "verbose",
},
"mod": {
"sys_analyser": {
"enabled": True,
"plot": True
}
}
}
run_code(code, config)
使用 run_func
函数来运行策略¶
此种模式下,您只需要在当前环境下定义策略函数,并传入指定运行的函数,即可运行策略。
# run_func_demo
from rqalpha.api import *
from rqalpha import run_func
def init(context):
logger.info("init")
context.s1 = "000001.XSHE"
update_universe(context.s1)
context.fired = False
def before_trading(context):
pass
def handle_bar(context, bar_dict):
if not context.fired:
# order_percent并且传入1代表买入该股票并且使其占有投资组合的100%
order_percent(context.s1, 1)
context.fired = True
config = {
"base": {
"start_date": "2016-06-01",
"end_date": "2016-12-01",
"benchmark": "000300.XSHG",
"accounts": {
"stock": 100000
}
},
"extra": {
"log_level": "verbose",
},
"mod": {
"sys_analyser": {
"enabled": True,
"plot": True
}
}
}
# 您可以指定您要传递的参数
run_func(init=init, before_trading=before_trading, handle_bar=handle_bar, config=config)
# 如果你的函数命名是按照 API 规范来,则可以直接按照以下方式来运行
# run_func(**globals())