Skip to content

Commit 3b948de

Browse files
committed
Update docs/images.
1 parent 20fd4ea commit 3b948de

File tree

3 files changed

+42
-7
lines changed

3 files changed

+42
-7
lines changed

README.md

+40-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
1-
# HyperTS
1+
# Welcome to HyperTS
2+
23
Easy-to-use, powerful, unified full pipeline automated time series toolkit. Supports forecasting, classification, regression and others.
34

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+
413
## Examples
514

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.
16+
617
```python
718
from hyperts.experiment import make_experiment
819
from hyperts.datasets import load_network_traffic
@@ -13,12 +24,10 @@ data = load_network_traffic()
1324
train_data, test_data = train_test_split(data, test_size=0.2, shuffle=False)
1425

1526
model = make_experiment(train_data.copy(),
16-
task='forecast',
17-
mode='dl',
18-
forecast_window=24*2,
27+
task='multivariate-forecast',
28+
mode='stats',
1929
timestamp='TimeStamp',
20-
covariables=['HourSin', 'WeekCos', 'CBWD'],
21-
max_trials=100).run()
30+
covariables=['HourSin', 'WeekCos', 'CBWD']).run()
2231

2332
X_test, y_test = model.split_X_y(test_data.copy())
2433

@@ -29,6 +38,31 @@ scores = model.evaluate(y_test, y_pred)
2938
model.plot(forecast=y_pred, actual=test_data, var_id=0)
3039
```
3140

41+
<div align="center"><img src="docs/static/images/Actual_vs_Forecast.jpg" width="800"/></div>
42+
43+
- 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).
65+
3266
## DataCanvas
3367

3468
![datacanvas](docs/static/images/dc_logo_1.png)
53.6 KB
Loading

requirements.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ numpy>=1.16.5, <1.19.4
66
pandas>=0.25.3
77
scikit-learn>=0.22.1
88
tensorflow>=2.0.0
9-
plotly>=4.12.0
9+
plotly>=4.12.0
10+
pyparsing==2.4.7

0 commit comments

Comments
 (0)