This is the official implementation of DoubleAdapt, an incremental learning framework for stock trend forecasting.
The paper has been accepted by KDD 2023, which is better to read in [arXiv].
To get rid of dependencies on qlib, please refer to our API repo. (This API repo is not well maintained and may have undiscovered bugs. We still recommend our qlib repo)
Sep 15, 2023 🔨 Support overriding learning rates during online training (meta-valid and meta-test).
It is highly recommended to tune offline and online learning rates.
We also CHANGED our argparser: the arg --lr now means the learning rate of forecast model, while a new arg --lr_da means that of data adapter.
The runner program is ./main.py.
The core implementation of the framework lies in qlib/contrib/meta/incremental/.
The implementation of any forecast model lies in qlib/contrib/model/ (e.g., GRU is in qlib/contrib/model/pytorch_gru.py).
# Naive incremental learning
python -u main.py run_all --forecast_model GRU --market csi300 --data_dir crowd_data --rank_label False --naive True
# DoubleAdapt
python -u main.py run_all --forecast_model GRU --market csi300 --data_dir crowd_data --rank_label False \
--num_head 8 --tau 10 --lr 0.001 --lr_da 0.01 --online_lr "{'lr': 0.001, 'lr_da': 0.0001, 'lr_ma': 0.001}"Following DDG-DA, we run experiments on the crowd-source version of qlib data which can be downloaded by
wget https://github.com/chenditc/investment_data/releases/download/2023-06-01/qlib_bin.tar.gz
tar -zxvf qlib_bin.tar.gz -C ~/.qlib/qlib_data/crowd_data --strip-components=2Arg --data_dir crowd_data and --data_dir cn_data for crowd-source data and Yahoo-source data, respectively.
Arg --alpha 360 or --alpha 158 for Alpha360 and Alpha 158, respectively.
Note that we are to predict the stock trend BUT NOT the rank of stock trend, which is different from DDG-DA.
To this end, we use CSZScoreNorm in the learn_processors instead of CSRankNorm.
Pay attention to the arg --rank_label False (or --rank_label True) for the target label.
As the current implementation is simple and may not suit rank labels, we recommend --adapt_y False when you have to set --rank_label True.
conda install higher -c conda-forge
# pip install higherThanks to github.com/facebookresearch/higher
This implementation requires ~8GB RAM on CSI500 when the update interval step is set to 20 trading days.
If your RAM is limited, you can split the function dump_data into two functions that dump training data and test data, respectively.
Then, free the storage of training data before testing.
Moreover, in our implementation, we cast all slices of stock data in pandas.DataFrame to torch.Tensor during data preprocessing.
This trick largely reduces CPU occupation during training and testing while it results in duplicate storage.
You can also set --preprocess_tensor False, reducing RAM occupation to ~5GB (peak 8GB before training).
Then, the data slices are created as virtual views of pandas.DataFrame, and the duplicates share the same memory address.
Each batch will be cast as torch.Tensor when needed, requesting new memory of a tiny size.
However, --preprocess_tensor False can exhaust all cores of the CPU and the speed is lower consequently.
DoubleAdapt requires at most 10GB GPU memory when step is set to 20.
The occupation will be smaller on CSI300 and on the default Yahoo data (which bears more missing values).
If your GPU is limited, try to set a smaller step (e.g., 5) which may take up ~2GB. And you can achieve higher performance.
The reason why we set
stepto 20 rather than 5 is that RR and DDG-DA bear unaffordable time costs (e.g., 3 days for 10 runs) in experiments withstepset to 5.
It is necessary to perform hyperparameter tuning for learning rates lr_da, lr_ma, and lr (learning rate of the lower level).
Note that the learning rates during online training could be different from those during offline training.
Fill arg
--online_lrto set different learning rates. Example:--online_lr "{'lr': 0.0005, 'lr_da': 0.0001, 'lr_ma': 0.0005}"
Arg --horizon decides the target label to be Ref($close, -horizon-1}) / Ref($close, -1) - 1 in the China A-share market.
Accordingly, there are always unknown ground-truth labels in the lasted horizon days of test data, and we can only use the rest for optimization of the meta-learners.
With a large horizon or a small step, the performance on the majority of the test data cannot be optimized,
and the meta-learners may well be overfitted and shortsighted.
We provide an arg --use_extra True to take the nearest data as additional test data, while the improvement is often little.
It is recommended to let step be greater than horizon by at least 3 or 4, e.g., --step 5 --horizon 1.
The current implementation does not support
step$\le$ horizon(e.g.,--step 1 --horizon 1) during online training.As the offline training can be conducted as usual, you can freeze the meta-learners online, initialize a forecast model by the model adapter, and then incrementally update the forecast model throughout the online phase.
We mainly experiment on a simple dataset Alpha360 where the feature adaptation only involves 6$\times$6 affine transformation with a few parameters to learn.
For more complex datasets, please carefully design a new adapter to reduce overfitting risks due to high-dimensional features.
If you find this useful for your work, please consider citing it as follows:
@InProceedings{DoubleAdapt,
author = {Lifan Zhao and Shuming Kong and Yanyan Shen},
booktitle = {Proceedings of the 29th {ACM} {SIGKDD} Conference on Knowledge Discovery and Data Mining},
title = {{DoubleAdapt}: A Meta-learning Approach to Incremental Learning for Stock Trend Forecasting},
year = {2023},
month = {aug},
publisher = {{ACM}},
doi = {10.1145/3580305.3599315},
}