Skip to main content

None

Project description

torchquantum

TorchQuantum is a backtesting framework that""" integrates the structure of PyTorch and WorldQuant's Operator for efficient quantitative financial analysis.

Contents

Installation

for Unix:

cd /path/to/your/directory
git clone git@github.com:nymath/torchqtm.git
cd ./torchqtm

Before running examples, you should compile the cython code.

python setup.py build_ext --inplace

Now you can run examples

python ./examples/main.py

If you are not downloading the dataset, then you should

cd ./examples
mkdir largedata
cd ./largedata
wget https://github.com/nymath/torchqtm/releases/download/V0.1/stocks_f64.pkl.zip
unzip stocks_f64.pkl.zip
rm stocks_f64.pkl.zip
cd ../
cd ../
git checkout dev

As for the backtesting dataset, we use the bundle provided by ricequant. We have wrapped the code into Makefile, you can just run the following command to download the bundle.

make rqalpha_download_bundle

for windows: We highly recommend you to use WSL2 to run torchquantum.

Examples

alpha mining

You can easily create an alpha through torchquantum!

import torchqtm.op as op
import torchqtm.op.functional as F


class NeutralizePE(op.Fundamental):
    def __init__(self, env):
        super().__init__(env)
        self.lag = op.Parameter(5, requires_optim=False, feasible_region=None)

    def forward(self):
        self.data = F.divide(1, self.env.PE)
        self.data = F.winsorize(self.data, 'std', 4)
        self.data = F.normalize(self.data)
        self.data = F.group_neutralize(self.data, self.env.Sector)
        self.data = F.regression_neut(self.data, self.env.MktVal)
        self.data = F.ts_mean(self.data, self.lag)
        return self.data
  • F is library that contains the operators defined by WorldQuant.
  • op.Fundamental implies the NeutralizePE belongs to fundamental alpha.
  • self.lag is the parameter of rolling mean, which can be optimized through grid search.

backtesting

Here we create a buy and hold strategy for illustration.

from torchqtm.edbt.algorithm import TradingAlgorithm
from torchqtm.assets import Equity

class BuyAndHold(TradingAlgorithm):
    def initialize(self):
        self.safe_set_attr("s0", Equity("000001.XSHE"))
        self.safe_set_attr("count", 0)

    def before_trading_start(self):
        pass

    def handle_data(self):
        if self.count == 0:
            self.order(self.s0, 10000)
        self.count += 1

    def analyze(self):
        pass

Features

  • High-speed backtesting framework (most of the operators are implemented through cython)
  • A revised gplearn library that is compatible with Alpha mining.
  • CNN and other state of the art models for mining alphas.
  • Event Driven backtesting framework is available.

Contribution

For more information, we refer to Documentation.

Join us

If you are interested in quantitative finance and are committed to devoting your life to alpha mining, you can contact me through WeChat at Ny_math.

References

quantopian/alphalens

quantopian/zipline

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

torchqtm-0.3.0.tar.gz (404.2 kB view details)

Uploaded Source

Built Distribution

torchqtm-0.3.0-cp39-cp39-macosx_10_9_x86_64.whl (426.2 kB view details)

Uploaded CPython 3.9 macOS 10.9+ x86-64

File details

Details for the file torchqtm-0.3.0.tar.gz.

File metadata

  • Download URL: torchqtm-0.3.0.tar.gz
  • Upload date:
  • Size: 404.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for torchqtm-0.3.0.tar.gz
Algorithm Hash digest
SHA256 bb2edfcaae0d2094634dbbbcc9eb2a38f1ad9518a104ad3a62332c89ee4e4fdd
MD5 61cc632e509604d5dc60236194139088
BLAKE2b-256 5fb2dc19d24adc55c335802fe4f5948c26947926dd944b66ee488228e4fb00c7

See more details on using hashes here.

File details

Details for the file torchqtm-0.3.0-cp39-cp39-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for torchqtm-0.3.0-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 820355faab9a7b81e7cf936d093d0a4ed68ee5626fa325ba1c1f0a59f77ebb68
MD5 1552cfd32ee3e14dd50041e8a1e8a043
BLAKE2b-256 2a3de70687a73e8e3b720cc12efd217bf4c0e3a7e6634fa3e715d0ce8c60ed08

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page