Explores time information to train a robust random forest
Project description
time-robust-forest
A Proof of concept model that explores timestamp information to train a random forest with better Out of Distribution generalization power.
Installation
pip install -U time-robust-forest
How to use it
There are a classifier and a regressor under time_robust_forest.models
. They follow the sklearn interface, which means you can quickly fit and use a model:
from time_robust_forest.models import TimeForestClassifier
features = ["x_1", "x_2"]
time_column = "periods"
target = "y"
model = TimeForestClassifier(time_column=time_column)
model.fit(training_data[features + [time_column]], training_data[target])
predictions = model.predict_proba(test_data[features])[:, 1]
There are only a few arguments that differ from a traditional Random Forest. two arguments
- time_column: the column from the input dataframe containing the time periods the model will iterate over to find the best splits (default: "period")
- min_sample_periods: the number of examples in every period the model needs to keep while it splits.
- period_criterion: how the performance in every period is going to be aggregated. Options: {"avg": average, "max": maximum, the worst case}. (default: "avg")
To use the environment-wise optimization:
from time_robust_forest.hyper_opt import env_wise_hyper_opt
params_grid = {"n_estimators": [30, 60, 120],
"max_depth": [5, 10],
"min_impurity_decrease": [1e-1, 1e-3, 0],
"min_sample_periods": [5, 10, 30],
"period_criterion": ["max", "avg"]}
model = TimeForestClassifier(time_column=time_column)
opt_param = env_wise_hyper_opt(training_data[features + [time_column]],
training_data[TARGET],
model,
time_column,
params_grid,
cv=5,
score=roc_auc_score)
Make sure you have a good choice for the time column
Don't simply use a timestamp column from the dataset, make it discrete before and guarantee there is a reasonable amount of data points in every period. Example: use year if you have 3+ years of data. Notice the choice to make it discrete becomes a modeling choice you can optimize.
License
This project is licensed under the terms of the BSD-3
license. See LICENSE for more details.
Useful links
Citation
@misc{time-robust-forest,
author = {Moneda, Luis},
title = {Time Robust Forest model},
year = {2021},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/lgmoneda/time-robust-forest}}
}
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
Hashes for time-robust-forest-0.1.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f931d0fbd758e8b569f86de68608c3ddef2d68d919ee289b872713ae26d40c95 |
|
MD5 | 6966be9d8496165f3af81a5ac8afaff4 |
|
BLAKE2b-256 | d14e47c126b25e6cc34417025736677dfa6dc2a7b26b8b44be7e483808fe6bc6 |
Hashes for time_robust_forest-0.1.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86255ab593eaa1bea38cfe40144d2b657dac59c245be05131a4ed21971a2e229 |
|
MD5 | 517f705e18204a668970006c107cb0cb |
|
BLAKE2b-256 | db078a61ac914182b69e8337f12a53726254e96282f3f440070a3441b4fecd29 |