Merge pull request #391 from WenjieDu/dev

Treat keyboard interruption during training as a warning, and update the docs
WenjieDu · May 8, 2024 · 9cdd37a · 9cdd37a
2 parents a95ae10 + 3a12082
commit 9cdd37a
Show file tree

Hide file tree

Showing 15 changed files with 166 additions and 145 deletions.
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@
   <img alt="Python version" src="https://img.shields.io/badge/Python-v3.7+-E97040?logo=python&logoColor=white">
  </a>
  <a href="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/WenjieDu/PyPOTS">
-  <img alt="powered by Pytorch" src="https://img.shields.io/badge/PyTorch-❤️-F8C6B5?logo=pytorch&logoColor=white">
+  <img alt="powered by Pytorch" src="https://img.shields.io/badge/PyTorch-%E2%9D%A4%EF%B8%8F-F8C6B5?logo=pytorch&logoColor=white">
  </a>
  <a href="https://github.com/WenjieDu/PyPOTS/releases">
   <img alt="the latest release version" src="https://img.shields.io/github/v/release/wenjiedu/pypots?color=EE781F&include_prereleases&label=Release&logo=github&logoColor=white">
@@ -53,7 +53,7 @@
   <img alt="arXiv DOI" src="https://img.shields.io/badge/DOI-10.48550/arXiv.2305.18811-F8F7F0">
  </a>
  <a href="https://github.com/WenjieDu/PyPOTS/blob/main/README_zh.md">
-  <img alt="README in Chinese" src="https://img.shields.io/badge/README-🇨🇳中文版-FCEFE8">
+  <img alt="README in Chinese" src="https://img.shields.io/badge/README-%F0%9F%87%A8%F0%9F%87%B3中文版-FCEFE8">
  </a>
 </p>
 
@@ -107,36 +107,36 @@ The task types are abbreviated as follows:
 **`ANOD`**: Anomaly Detection.
 The paper references and links are all listed at the bottom of this file.
 
-| **Type** | **Algo** | **IMPU** | **FORE** | **CLAS** | **CLUS** | **ANOD** | **Year - Venue** |
-|:--------------|:-----------------------------------|:--------:|:--------:|:--------:|:--------:|:--------:|:-----------------|
-| Neural Net | iTransformer[^24] | ✅ | | | | | 2024 - ICLR |
-| Neural Net | SAITS[^1] | ✅ | | | | | 2023 - ESWA |
-| Neural Net | FreTS[^23] | ✅ | | | | | 2023 - NeurIPS |
-| Neural Net | Crossformer[^16] | ✅ | | | | | 2023 - ICLR |
-| Neural Net | TimesNet[^14] | ✅ | | | | | 2023 - ICLR |
-| Neural Net | PatchTST[^18] | ✅ | | | | | 2023 - ICLR |
-| Neural Net | ETSformer[^19] | ✅ | | | | | 2023 - ICLR |
-| Neural Net | DLinear[^17] | ✅ | | | | | 2023 - AAAI |
-| Neural Net | Nonstationary <br>Transformer[^25] | ✅ | | | | | 2022 - NeurIPS |
-| Neural Net | FiLM[^22] | ✅ | | | | | 2022 - NeurIPS |
-| Neural Net | Pyraformer[^26] | | | ✅ | | | 2022 - ICLR |
-| Neural Net | Raindrop[^5] | | | ✅ | | | 2022 - ICLR |
-| Neural Net | FEDformer[^20] | ✅ | | | | | 2022 - ICML |
-| Neural Net | Autoformer[^15] | ✅ | | | | | 2021 - NeurIPS |
-| Neural Net | CSDI[^12] | ✅ | ✅ | | | | 2021 - NeurIPS |
-| Neural Net | Informer[^21] | ✅ | | | | | 2021 - AAAI |
-| Neural Net | US-GAN[^10] | ✅ | | | | | 2021 - AAAI |
-| Neural Net | CRLI[^6] | | | | ✅ | | 2021 - AAAI |
-| Probabilistic | BTTF[^8] | | ✅ | | | | 2021 - TPAMI |
-| Neural Net | GP-VAE[^11] | ✅ | | | | | 2020 - AISTATS |
-| Neural Net | VaDER[^7] | | | | ✅ | | 2019 - GigaSci. |
-| Neural Net | M-RNN[^9] | ✅ | | | | | 2019 - TBME |
-| Neural Net | BRITS[^3] | ✅ | | ✅ | | | 2018 - NeurIPS |
-| Neural Net | GRU-D[^4] | ✅ | | ✅ | | | 2018 - Sci. Rep. |
-| Neural Net | Transformer[^2] | ✅ | | | | | 2017 - NeurIPS |
-| Naive | LOCF/NOCB | ✅ | | | | | |
-| Naive | Mean | ✅ | | | | | |
-| Naive | Median | ✅ | | | | | |
+| **Type** | **Algo** | **IMPU** | **FORE** | **CLAS** | **CLUS** | **ANOD** | **Year - Venue**  |
+|:--------------|:-----------------------------------|:--------:|:--------:|:--------:|:--------:|:--------:|:-------------------|
+| Neural Net | iTransformer[^24] | ✅ | | | | | `2024 - ICLR` |
+| Neural Net | SAITS[^1] | ✅ | | | | | `2023 - ESWA` |
+| Neural Net | FreTS[^23] | ✅ | | | | | `2023 - NeurIPS` |
+| Neural Net | Crossformer[^16] | ✅ | | | | | `2023 - ICLR` |
+| Neural Net | TimesNet[^14] | ✅ | | | | | `2023 - ICLR` |
+| Neural Net | PatchTST[^18] | ✅ | | | | | `2023 - ICLR` |
+| Neural Net | ETSformer[^19] | ✅ | | | | | `2023 - ICLR` |
+| Neural Net | DLinear[^17] | ✅ | | | | | `2023 - AAAI` |
+| Neural Net | Nonstationary <br>Transformer[^25] | ✅ | | | | | `2022 - NeurIPS` |
+| Neural Net | FiLM[^22] | ✅ | | | | | `2022 - NeurIPS` |
+| Neural Net | Pyraformer[^26] | | | ✅ | | | `2022 - ICLR` |
+| Neural Net | Raindrop[^5] | | | ✅ | | | `2022 - ICLR` |
+| Neural Net | FEDformer[^20] | ✅ | | | | | `2022 - ICML` |
+| Neural Net | Autoformer[^15] | ✅ | | | | | `2021 - NeurIPS` |
+| Neural Net | CSDI[^12] | ✅ | ✅ | | | | `2021 - NeurIPS` |
+| Neural Net | Informer[^21] | ✅ | | | | | `2021 - AAAI` |
+| Neural Net | US-GAN[^10] | ✅ | | | | | `2021 - AAAI` |
+| Neural Net | CRLI[^6] | | | | ✅ | | `2021 - AAAI` |
+| Probabilistic | BTTF[^8] | | ✅ | | | | `2021 - TPAMI` |
+| Neural Net | GP-VAE[^11] | ✅ | | | | | `2020 - AISTATS` |
+| Neural Net | VaDER[^7] | | | | ✅ | | `2019 - GigaSci.` |
+| Neural Net | M-RNN[^9] | ✅ | | | | | `2019 - TBME` |
+| Neural Net | BRITS[^3] | ✅ | | ✅ | | | `2018 - NeurIPS` |
+| Neural Net | GRU-D[^4] | ✅ | | ✅ | | | `2018 - Sci. Rep.` |
+| Neural Net | Transformer[^2] | ✅ | | | | | `2017 - NeurIPS` |
+| Naive | LOCF/NOCB | ✅ | | | | |  |
+| Naive | Mean | ✅ | | | | |  |
+| Naive | Median | ✅ | | | | |  |
 
 
 ## ❖ PyPOTS Ecosystem

diff --git a/README_zh.md b/README_zh.md
@@ -11,7 +11,7 @@
   <img alt="Python version" src="https://img.shields.io/badge/Python-v3.7+-E97040?logo=python&logoColor=white">
  </a>
  <a href="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/WenjieDu/PyPOTS">
-  <img alt="powered by Pytorch" src="https://img.shields.io/badge/PyTorch-❤️-F8C6B5?logo=pytorch&logoColor=white">
+  <img alt="powered by Pytorch" src="https://img.shields.io/badge/PyTorch-%E2%9D%A4%EF%B8%8F-F8C6B5?logo=pytorch&logoColor=white">
  </a>
  <a href="https://github.com/WenjieDu/PyPOTS/releases">
   <img alt="the latest release version" src="https://img.shields.io/github/v/release/wenjiedu/pypots?color=EE781F&include_prereleases&label=Release&logo=github&logoColor=white">
@@ -53,7 +53,7 @@
   <img alt="arXiv DOI" src="https://img.shields.io/badge/DOI-10.48550/arXiv.2305.18811-F8F7F0">
  </a>
  <a href="https://github.com/WenjieDu/PyPOTS/blob/main/README.md">
-  <img alt="README in English" src="https://img.shields.io/badge/README-🇺🇸in_English-FCEFE8">
+  <img alt="README in English" src="https://img.shields.io/badge/README-%F0%9F%87%BA%F0%9F%87%B8in_English-FCEFE8">
  </a>
 </p>
 
@@ -95,35 +95,34 @@ PyPOTS当前支持多变量POTS数据的插补，预测，分类，聚类以及
 
 | **类型** | **算法** | **插补** | **预测** | **分类** | **聚类** | **异常检测** | **年份 - 刊物** |
 |:--------------|:-----------------------------------|:------:|:------:|:------:|:------:|:--------:|:-----------------|
-| Neural Net | iTransformer[^24] | ✅ | | | | | 2024 - ICLR |
-| Neural Net | SAITS[^1] | ✅ | | | | | 2023 - ESWA |
-| Neural Net | FreTS[^23] | ✅ | | | | | 2023 - NeurIPS |
-| Neural Net | Koopa[^27] | ✅ | | | | | 2023 - NeurIPS |
-| Neural Net | Crossformer[^16] | ✅ | | | | | 2023 - ICLR |
-| Neural Net | TimesNet[^14] | ✅ | | | | | 2023 - ICLR |
-| Neural Net | PatchTST[^18] | ✅ | | | | | 2023 - ICLR |
-| Neural Net | ETSformer[^19] | ✅ | | | | | 2023 - ICLR |
-| Neural Net | DLinear[^17] | ✅ | | | | | 2023 - AAAI |
-| Neural Net | Nonstationary <br>Transformer[^25] | ✅ | | | | | 2022 - NeurIPS |
-| Neural Net | FiLM[^22] | ✅ | | | | | 2022 - NeurIPS |
-| Neural Net | Pyraformer[^26] | | | ✅ | | | 2022 - ICLR |
-| Neural Net | Raindrop[^5] | | | ✅ | | | 2022 - ICLR |
-| Neural Net | FEDformer[^20] | ✅ | | | | | 2022 - ICML |
-| Neural Net | Autoformer[^15] | ✅ | | | | | 2021 - NeurIPS |
-| Neural Net | CSDI[^12] | ✅ | ✅ | | | | 2021 - NeurIPS |
-| Neural Net | Informer[^21] | ✅ | | | | | 2021 - AAAI |
-| Neural Net | US-GAN[^10] | ✅ | | | | | 2021 - AAAI |
-| Neural Net | CRLI[^6] | | | | ✅ | | 2021 - AAAI |
-| Probabilistic | BTTF[^8] | | ✅ | | | | 2021 - TPAMI |
-| Neural Net | GP-VAE[^11] | ✅ | | | | | 2020 - AISTATS |
-| Neural Net | VaDER[^7] | | | | ✅ | | 2019 - GigaSci. |
-| Neural Net | M-RNN[^9] | ✅ | | | | | 2019 - TBME |
-| Neural Net | BRITS[^3] | ✅ | | ✅ | | | 2018 - NeurIPS |
-| Neural Net | GRU-D[^4] | ✅ | | ✅ | | | 2018 - Sci. Rep. |
-| Neural Net | Transformer[^2] | ✅ | | | | | 2017 - NeurIPS |
-| Naive | LOCF/NOCB | ✅ | | | | | |
-| Naive | Mean | ✅ | | | | | |
-| Naive | Median | ✅ | | | | | |
+| Neural Net | iTransformer[^24] | ✅ | | | | | `2024 - ICLR` |
+| Neural Net | SAITS[^1] | ✅ | | | | | `2023 - ESWA` |
+| Neural Net | FreTS[^23] | ✅ | | | | | `2023 - NeurIPS` |
+| Neural Net | Crossformer[^16] | ✅ | | | | | `2023 - ICLR` |
+| Neural Net | TimesNet[^14] | ✅ | | | | | `2023 - ICLR` |
+| Neural Net | PatchTST[^18] | ✅ | | | | | `2023 - ICLR` |
+| Neural Net | ETSformer[^19] | ✅ | | | | | `2023 - ICLR` |
+| Neural Net | DLinear[^17] | ✅ | | | | | `2023 - AAAI` |
+| Neural Net | Nonstationary <br>Transformer[^25] | ✅ | | | | | `2022 - NeurIPS` |
+| Neural Net | FiLM[^22] | ✅ | | | | | `2022 - NeurIPS` |
+| Neural Net | Pyraformer[^26] | | | ✅ | | | `2022 - ICLR` |
+| Neural Net | Raindrop[^5] | | | ✅ | | | `2022 - ICLR` |
+| Neural Net | FEDformer[^20] | ✅ | | | | | `2022 - ICML` |
+| Neural Net | Autoformer[^15] | ✅ | | | | | `2021 - NeurIPS` |
+| Neural Net | CSDI[^12] | ✅ | ✅ | | | | `2021 - NeurIPS` |
+| Neural Net | Informer[^21] | ✅ | | | | | `2021 - AAAI` |
+| Neural Net | US-GAN[^10] | ✅ | | | | | `2021 - AAAI` |
+| Neural Net | CRLI[^6] | | | | ✅ | | `2021 - AAAI` |
+| Probabilistic | BTTF[^8] | | ✅ | | | | `2021 - TPAMI` |
+| Neural Net | GP-VAE[^11] | ✅ | | | | | `2020 - AISTATS` |
+| Neural Net | VaDER[^7] | | | | ✅ | | `2019 - GigaSci.` |
+| Neural Net | M-RNN[^9] | ✅ | | | | | `2019 - TBME` |
+| Neural Net | BRITS[^3] | ✅ | | ✅ | | | `2018 - NeurIPS` |
+| Neural Net | GRU-D[^4] | ✅ | | ✅ | | | `2018 - Sci. Rep.` |
+| Neural Net | Transformer[^2] | ✅ | | | | | `2017 - NeurIPS` |
+| Naive | LOCF/NOCB | ✅ | | | | | |
+| Naive | Mean | ✅ | | | | | |
+| Naive | Median | ✅ | | | | | |
 
 
 ## ❖ PyPOTS生态系统