Skip to content

Commit

Permalink
docs: update README;
Browse files Browse the repository at this point in the history
  • Loading branch information
WenjieDu committed Jun 22, 2024
1 parent 9cafa29 commit 3b4bf12
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 64 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,18 @@ The README file here maintains a list of must-read papers on time-series imputat

## ❖ Time-Series Imputation Toolkits
### `Datasets`
[TSDB (Time Series Data Beans)](https://github.com/WenjieDu/TSDB): a Python toolkit can load 169 public time-series datasets with a single line of code.
[TSDB (Time Series Data Beans)](https://github.com/WenjieDu/TSDB): a Python toolkit can load 170 public time-series datasets with a single line of code.
<img src="https://img.shields.io/github/last-commit/WenjieDu/TSDB" align="center">

[BenchPOTS](https://github.com/WenjieDu/BenchPOTS): a Python suite provides standard preprocessing pipelines of 170 public datasets for benchmarking machine learning on POTS (Partially-Observed Time Series).
<img src="https://img.shields.io/github/last-commit/WenjieDu/BenchPOTS" align="center">

### `Missingness`
[PyGrinder](https://github.com/WenjieDu/PyGrinder): a Python library grinds data beans into the incomplete by introducing missing values with different missing patterns.
<img src="https://img.shields.io/github/last-commit/WenjieDu/PyGrinder" align="center">

### `Algorithms`
[PyPOTS](https://github.com/WenjieDu/PyPOTS): a Python toolbox for data mining on Partially-Observed Time Series
[PyPOTS](https://github.com/WenjieDu/PyPOTS): a Python toolbox for data mining on POTS (Partially-Observed Time Series)
<img src="https://img.shields.io/github/last-commit/WenjieDu/PyPOTS" align="center">

[MICE](https://github.com/amices/mice): Multivariate Imputation by Chained Equations
Expand Down Expand Up @@ -222,7 +225,7 @@ researchers and practitioners who are interested in this field.
[AI for Time Series (AI4TS) Papers, Tutorials, and Surveys](https://github.com/qingsongedu/awesome-AI-for-time-series-papers)

## ❖ Citing This Work
If you find this repository helpful to your work, please kindly star it and cite our benchmark paper and survey paper as follows:
If you find this repository helpful to your work, please kindly star it and cite our benchmark paper, survey paper, and PyPOTS as follows:

```bibtex
@article{du2024tsibench,
Expand All @@ -242,6 +245,14 @@ year={2024}
}
```

```bibtex
@article{du2023pypots,
title={{PyPOTS: a Python toolbox for data mining on Partially-Observed Time Series}},
author={Wenjie Du},
journal={arXiv preprint arXiv:2305.18811},
year={2023},
}
```

<details>
<summary>🏠 Visits</summary>
Expand Down
63 changes: 2 additions & 61 deletions benchmark_code/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Please ensure that all the below library requirements are satisfied.
```yaml
tsdb ==0.4
pygrinder ==0.6
benchpots ==0.1
benchpots ==0.1.1
pypots ==0.6
```

Expand Down Expand Up @@ -46,63 +46,4 @@ To obtain the results of the naive methods, check out the commands in the shell


## ❖ Downstream Tasks


### Classification

```shell
python downstream_classification.py \
--model SAITS \
--dataset PhysioNet2012 \
--dataset_fold_path data/physionet_2012_rate01_point \
--model_result_parent_fold results_point_rate01/SAITS_PhysioNet2012 \
--device cuda:0 \
--n_classes 2

python downstream_classification.py \
--model SAITS \
--dataset Pedestrian \
--dataset_fold_path data/melbourne_pedestrian_rate01_step24_point \
--model_result_parent_fold results_point_rate01/SAITS_Pedestrian \
--device cuda:2 \
--n_classes 10

python downstream_classification_naive.py \
--dataset_fold_path data/physionet_2012_rate01_point \
--dataset PhysioNet2012 \
--device cuda:3 \
--n_classes 2
```

### Regression

```shell
python downstream_regression.py \
--model SAITS \
--dataset ETT_h1 \
--dataset_fold_path data/ett_rate01_step48_point \
--model_result_parent_fold results_point_rate01/SAITS_ETT_h1 \
--device cuda:0

python downstream_regression_naive.py \
--dataset_fold_path data/ett_rate01_step48_point \
--dataset ETT_h1 \
--device cuda:3
```


### Forecasting

```shell
python downstream_forecasting.py \
--model SAITS \
--dataset ETT_h1 \
--dataset_fold_path data/ett_rate01_step48_point \
--model_result_parent_fold results_point_rate01/SAITS_ETT_h1 \
--device cuda:0

python downstream_forecasting_naive.py \
--dataset_fold_path data/ett_rate01_step48_point \
--dataset ETT_h1 \
--device cuda:3
```
We're clean up the code and updating the scripts for the downstream tasks. Will release the code soon.

0 comments on commit 3b4bf12

Please sign in to comment.