You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+40-6
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,19 @@
1
-
# HyperTS
1
+
# Welcome to HyperTS
2
+
2
3
Easy-to-use, powerful, unified full pipeline automated time series toolkit. Supports forecasting, classification, regression and others.
3
4
5
+
## Overview
6
+
HyperTS is a Python package that provides an end-to-end time series (TS) analysis toolkit. It covers complete and flexible AutoML workflows for TS, including data clearning, preprocessing, feature engineering, model selection, hyperparamter optimization, result evaluation, and visualization.
7
+
8
+
Multi-mode drive, light-heavy combination is the highlight feature of HyperTS. Therefore, statistical models (STATS), deep learning (DL), and neural architecture search (NAS) can be switched arbitrarily to get a powerful TS estimator.
9
+
10
+
Easy-to-use and lower-level API. Users can get a model after simply running the experiment, and then execute ```.predict()```, ```.predict_proba()```, ```.evalute()```, ```.plot()``` for various time series analysis.
11
+
12
+
4
13
## Examples
5
14
15
+
Users can quickly create and ```run()``` an experiment with ```make_experiment()```, where ```train_data```, and ```task``` as required input parameters. In the forecast task in the following example, we tell the experiment that it is a multivariate-forecast ```task```, using stats ```mode```, since the data contains timestamp and covariable columns, ```timestamp``` and ```covariables``` parameters might inform the experiment.
- More detailed guides: [EXAMPLES.](https://github.com/DataCanvasIO/HyperTS/tree/main/examples)
44
+
45
+
## Key Features
46
+
47
+
HyperTS supports the following features:
48
+
49
+
**Multi-task Support:** Time series forecasting, classification, and regression.
50
+
51
+
**Multi-mode Support:** A large collection of TS models, from statistical models to deep learning models, and to neural architecture search (developing).
52
+
53
+
**Multi-variate Support:** From univariate to multivariate time series.
54
+
55
+
**Covariates Support:** Deep learning models support covariates as input featues for time series forecasting.
56
+
57
+
**Probabilistic intervals Support:** Time series forecsting visualization can show confidence intervals.
58
+
59
+
**Abundant Metrics:** From ```MSE```,``` SMAPE```, ```Accuracy``` to ```F1-Score```, a variety of performance metrics to evaluate results and guide models optimization.
60
+
61
+
**Powerful search strategies:** Adapting Grid Search, Monte Carlo Tree Search, Evolution Algorithm combined with a meta-learner to learn a powerful and effective pipeline.
62
+
63
+
## Communication
64
+
If you wish to contribute to this project, please refer to [CONTRIBUTING](CONTRIBUTING.md).
0 commit comments