Time series cross-validation
Project description
TSCV: Time Series Cross-Validation
This repository is a scikit-learn extension for time series cross-validation. It introduces gaps between the training set and the test set, which mitigates the temporal dependence of time series and prevents information leakage.
Installation
pip install tscv
or
conda install -c conda-forge tscv
Usage
This extension defines 3 cross-validator classes and 1 function:
GapLeavePOut
GapKFold
GapRollForward
gap_train_test_split
The three classes can all be passed, as the cv
argument, to
scikit-learn functions such as cross-validate
, cross_val_score
,
and cross_val_predict
, just like the native cross-validator classes.
The one function is an alternative to the train_test_split
function in scikit-learn
.
Examples
The following example uses GapKFold
instead of KFold
as the cross-validator.
import numpy as np
from sklearn import datasets
from sklearn import svm
from sklearn.model_selection import cross_val_score
from tscv import GapKFold
iris = datasets.load_iris()
clf = svm.SVC(kernel='linear', C=1)
# use GapKFold as the cross-validator
cv = GapKFold(n_splits=5, gap_before=5, gap_after=5)
scores = cross_val_score(clf, iris.data, iris.target, cv=cv)
The following example uses gap_train_test_split
to split the data set into the training set and the test set.
import numpy as np
from tscv import gap_train_test_split
X, y = np.arange(20).reshape((10, 2)), np.arange(10)
X_train, X_test, y_train, y_test = gap_train_test_split(X, y, test_size=2, gap_size=2)
Contributing
- Report bugs in the issue tracker
- Express your use cases in the issue tracker
Documentations
Acknowledgments
- I would like to thank Jeffrey Racine and Christoph Bergmeir for the helpful discussion.
License
BSD-3-Clause
Citation
Wenjie Zheng. (2021). Time Series Cross-Validation (TSCV): an extension for scikit-learn. Zenodo. http://doi.org/10.5281/zenodo.4707309
@software{zheng_2021_4707309,
title={{Time Series Cross-Validation (TSCV): an extension for scikit-learn}},
author={Zheng, Wenjie},
month={april},
year={2021},
publisher={Zenodo},
doi={10.5281/zenodo.4707309},
url={http://doi.org/10.5281/zenodo.4707309}
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file tscv-0.1.3.tar.gz
.
File metadata
- Download URL: tscv-0.1.3.tar.gz
- Upload date:
- Size: 13.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4934fcc9d5210d0bc4efcade76c195be2fb10bed82c827b05ac39953ef4dddc9 |
|
MD5 | 1e5511c67553779a812c3a9aa88173d2 |
|
BLAKE2b-256 | cd5a7ebce6c6baa22f9fd4a6b87249d347c6339a1f5537279e03999fcf06b95c |
File details
Details for the file tscv-0.1.3-py3-none-any.whl
.
File metadata
- Download URL: tscv-0.1.3-py3-none-any.whl
- Upload date:
- Size: 12.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8503ea18719b9891830dd436640990ccf4c5466307951454da9fd1a5a3243ce9 |
|
MD5 | 60caf5f52733e3b4e3a3f730544d4296 |
|
BLAKE2b-256 | 65bdadaa4803a999efcb2feba16359cd6d7361a8edcdc26497a54ca796811392 |