BigQuant使用文档

BigModule简介与入门

由small_q创建,最终由small_q 被浏览 385 用户

BigModule

bigmodule模块是由Python语言编写的,主要是在可视化线性策略中使用的可视化部件,可以将繁杂的代码进行封装,而只把输入和输出暴露给使用者,这样用户就无需关心模块的内部实现,而只需提供相应的数据,便可以获得想要的结果。

由此一来,大大降低用户在构建个人策略时的上手门槛和使用难度,即使不具备任何代码知识,也能做到 “开箱即用” 📦。

创建BigModule模块模板

首先,进入到线上开发环境中 BigQuant AIStudio

在命令行终端中输入以下命令创建模板:

# 初始化一个模块模板, 把 “模块名称” 替换为你想要取的名称, 例如 hello
bq module init 模块名称

示例:

在输入上述命令后,便会开始执行模板创建的流程,在该过程中我们还需要依据提示在命令行终端中输入模块描述:

Initialized a hello project # 此为命令行终端提示
  Your project description  # 此为命令行终端提示
  关于模块的简单描述(使用英文填写) # <- 在本行输入

示例:

\

在本地安装模块

要想使用自己所创建的模块,必须先进行安装操作。

在命令行中输入以下命令,在本地开发环境中安装模块。

# 首先进入模块的根目录
cd hello
# 执行以下命令进行安装
bq module install --dev

示例:

这时,创建或打开一个可视化线性策略,然后在左侧目录"开发"->"示例模块"下找到我们刚刚创建的模块,双击该模块,即可创建相应的实例。

在本地创建的模块版本会被默认设置为 9999,在右侧可以看到此模块的参数输入栏,以及相关信息。

若目录中未加载出该模块,请尝试刷新网页。

在本地卸载模块

# 首先进入模块的根目录
cd hello
# 执行以下命令进行卸载
bq module uninstall --dev

这样,在本地安装的该模块会被删除,即无法在左侧目录"开发"->"示例模块"下找到。

示例:

发布模块

如果自己的代码在本地测试完毕且表现良好,期望让更多的人使用,可以将模块发布到模块库🎉。

需要注意,在发布模块之前,为了防止出现问题,需要先在本地卸载该模块,然后在终端中输入以下命令:

bq module publish

之后可以在可视化策略里面的用户路径下找到自己编写的模块。

{link}