zhostev / sqlib

Introduction to the decoupling solutions of qlib, an open-source software library for signal processing and machine learning.

sqlib

ProjectName and Description

"sqlib介绍

一个"完美的"README去快速开始你的项目！
探索本项目的文档 »

查看Demo · 报告Bug · 提出新特性

本篇README.md面向开发者

目录

• 上手指南
  • 开发前的配置要求
  • 安装步骤
• 文件目录说明
• 开发的架构
• 部署
• 使用到的框架
• 贡献者
  • 如何参与开源项目
• 版本控制
• 作者
• 鸣谢

上手指南

请将所有链接中的“shaojintian/Best_README_template”改为“your_github_name/your_repository”

开发前的配置要求

1. 本版本支持Ubuntu，其他系统未作详细测试。
2. 依赖微软量化交易平台qlib。

安装步骤

1. 安装qlib
2. Clone the repo

git clone https://github.com/vinsvison/sqlib.git

文件目录说明

filetree 
├── ARCHITECTURE.md
├── LICENSE.txt
├── README.md
├── /account/
├── /bbs/
├── /docs/
│  ├── /rules/
│  │  ├── backend.txt
│  │  └── frontend.txt
├── manage.py
├── /oa/
├── /static/
├── /templates/
├── useless.md
└── /util/

开发的架构

请阅读ARCHITECTURE.md 查阅为该项目的架构。

部署

1、qlib安装

具体参考：https://qlib.readthedocs.io/en/latest/start/installation.html 可以直接 pip install qlib 若需要修改源码的，建议源码安装。

pip install numpy
pip install --upgrade cython
git clone https://github.com/microsoft/qlib.git && cd qlib
python setup.py install

特别说明：支持python==3.8版本。

2、安装mlflow

具体参考：https://github.com/Toumash/mlflow-docker

根据自己的实际情况修改.env

执行几个sh脚本后，运行docker-compose up -d

特别说明：也可以直接 pip install mlflow 然后mlflow ui 启动服务

3、安装prefect

启动postgres

docker run -d --name prefect-postgres -v prefectdb:/var/lib/postgresql/data -p 5432:5432 -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=prefect -e POSTGRES_DB=prefect postgres:latest

安装prefect包

pip install prefect

设置prefect数据库

prefect config set PREFECT_API_DATABASE_CONNECTION_URL="postgresql+asyncpg://postgres:prefect@localhost:5432/prefect"

启动

docker start prefect-postgres
prefect server start

4、安装superset容器, 并设置登录用户名密码等

docker run -d -p 8080:8088 -v /home/idea/qlib/qlib_t/sqlib:/home/superset/app -e "SUPERSET_SECRET_KEY=sqlib1234" --name superset amancevice/superset

docker exec -it superset superset-init 

进入superset容器, 并安装duckdb-engine

docker exec -it superset bash

pip install duckdb-engine -i https://pypi.tuna.tsinghua.edu.cn/simple

exit

重启superset容器

docker restart superset

使用到的框架

• qlib
• mlflow
• prefect
• superset
• duckdb

贡献者

请阅读CONTRIBUTING.md 查阅为该项目做出贡献的开发者。

如何参与开源项目

贡献使开源社区成为一个学习、激励和创造的绝佳场所。你所作的任何贡献都是非常感谢的。

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

版本控制

该项目使用Git进行版本管理。您可以在repository参看当前可用版本。

作者

[email protected]

知乎:zhihu.com/people/ideaplat  qq group : 851540137

您也可以在贡献者名单中参看所有参与该项目的开发者。

版权说明

该项目签署了MIT 授权许可，详情请参阅 LICENSE.txt

鸣谢