Merge pull request #490 from WenjieDu/dev

Refactor Gungnir logging and update docs

.readthedocs.yaml

@@ -25,7 +25,7 @@ build:
             - pip install torch-geometric==2.3.1 torch-scatter==2.1.1 torch-sparse==0.6.17 -f "https://data.pyg.org/whl/torch-1.13.1+cpu.html"
             - pip install -r requirements/requirements.txt
             - pip install pypots
-            - pip install sphinx==6.2.1 docutils==0.19 sphinxcontrib-bibtex==2.1.4 sphinxcontrib-gtagjs sphinx-autodoc-typehints furo==2023.07.26
+            - pip install sphinx==7.4.7 docutils==0.21.2 sphinxcontrib-bibtex==2.6.2 sphinxcontrib-gtagjs sphinx-autodoc-typehints furo==2024.7.18
             - git clone https://github.com/WenjieDu/TSDB TSDB_repo --depth 1 && pip install ./TSDB_repo
             - git clone https://github.com/WenjieDu/PyGrinder PyGrinder_repo --depth 1 && pip install ./PyGrinder_repo
             - git clone https://github.com/WenjieDu/BenchPOTS BenchPOTS_repo --depth 1 && pip install ./BenchPOTS_repo
@@ -34,7 +34,7 @@ build:
         post_install:
             # To fix the exception: This documentation is not using `furo.css` as the stylesheet.
             #   If you have set `html_style` in your conf.py file, remove it.
-            - pip install sphinx==7.2.6
+            - pip install sphinx==7.4.7
             # this docutils version fixes issue#102, put it in post_install to avoid being
             #   overwritten by other versions (like 0.19) while installing other packages
-            - pip install docutils==0.20
+            - pip install docutils==0.21.2

README.md

@@ -152,6 +152,9 @@ The paper references and links are all listed at the bottom of this file.
 | Naive         | Mean                        |    ✅     |          |          |          |          |                    |
 | Naive         | Median                      |    ✅     |          |          |          |          |                    |
 
+💯 Contribute your model right now to increase your research impact! PyPOTS downloads are increasing rapidly (**[300K+ in total and 1K+ daily on PyPI so far](https://www.pepy.tech/projects/pypots)**),
+and your work will be widely used and cited by the community.
+Refer to the [contribution guide](https://github.com/WenjieDu/PyPOTS#-contribution) to see how to include your model in PyPOTS.
 
 ## ❖ PyPOTS Ecosystem
 At PyPOTS, things are related to coffee, which we're familiar with. Yes, this is a coffee universe!

README_zh.md

@@ -138,6 +138,8 @@ PyPOTS当前支持多变量POTS数据的插补，预测，分类，聚类以及
 | Naive         | Mean                        |    ✅     |          |          |          |          |                    |
 | Naive         | Median                      |    ✅     |          |          |          |          |                    |
 
+💯 现在贡献你的模型来增加你的研究影响力！PyPOTS的下载量正在迅速增长(**[目前PyPI上总共超过30万次且每日超1000的下载](https://www.pepy.tech/projects/pypots)**),
+你的工作将被社区广泛使用和引用。请参阅[贡献指南](https://github.com/WenjieDu/PyPOTS/blob/main/README_zh.md#-%E8%B4%A1%E7%8C%AE%E5%A3%B0%E6%98%8E)，了解如何将模型包含在PyPOTS中。
 
 ## ❖ PyPOTS生态系统
 在PyPOTS生态系统中，一切都与我们熟悉的咖啡息息相关，甚至可以将其视为一杯咖啡的诞生过程！

docs/index.rst

@@ -210,6 +210,9 @@ The paper references are all listed at the bottom of this readme file.
 | Naive          | Mean                                                      |  ✅  |      |      |      |      |                       |
 +----------------+-----------------------------------------------------------+------+------+------+------+------+-----------------------+
 
+💯 Contribute your model right now to increase your research impact! PyPOTS downloads are increasing rapidly (`300K+ in total and 1K+ daily on PyPI so far <https://www.pepy.tech/projects/pypots>`_),
+and your work will be widely used and cited by the community.
+Refer to the `contribution guide <https://github.com/WenjieDu/PyPOTS#-contribution>`_ to see how to include your model in PyPOTS.
 
 ❖ PyPOTS Ecosystem
 ^^^^^^^^^^^^^^^^^^^

docs/milestones.rst

@@ -49,3 +49,4 @@ Project Milestones
 - 2023-12: PyPOTS achieves its first 500 stars 🌟;
 - 2024-02: PyPOTS Research releases its imputation survey paper `Deep Learning for Multivariate Time Series Imputation: A Survey <https://arxiv.org/abs/2402.04059>`_;
 - 2024-06: PyPOTS Research releases the 1st comprehensive time-series imputation benchmark paper `TSI-Bench: Benchmarking Time Series Imputation <https://arxiv.org/abs/2406.12747>`_;
+- 2024-08: PyPOTS Research presents the keynote "Learning from Partially Observed Time Series: Towards Reality-Centric AI4TS" `IJCAI'24 AI4TS workshop <https://arxiv.org/abs/2406.12747>`_;

docs/pypots.data.rst

@@ -28,14 +28,6 @@ pypots.data.generating
    :show-inheritance:
    :inherited-members:
 
-pypots.data.load\_preprocessing
---------------------------------------
-
-.. automodule:: pypots.data.load_preprocessing
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :inherited-members:
 
 pypots.data.load\_specific\_datasets
 -------------------------------------------

docs/references.bib

@@ -746,7 +746,7 @@ @inproceedings{xu2024fits
 url={https://openreview.net/forum?id=bWcnvZ3qMb}
 }
 
-@article{nie2024imputeformer,
+@inproceedings{nie2024imputeformer,
 title={ImputeFormer: Low Rankness-Induced Transformers for Generalizable Spatiotemporal Imputation},
 author={Nie, Tong and Qin, Guoyang and Ma, Wei and Mei, Yuewen and Sun, Jian},
 booktitle = {Proceedings of the 30th ACM SIGKDD Conference on Knowledge Discovery and Data Mining},
@@ -762,4 +762,4 @@ @article{bai2018tcn
 author={Bai, Shaojie and Kolter, J Zico and Koltun, Vladlen},
 journal={arXiv preprint arXiv:1803.01271},
 year={2018}
-}
+}

pypots/gungnir/client.py

@@ -7,12 +7,6 @@
 
 from ..utils.logging import logger
 
-logger.info(
-    "The functionalities of client Gungnir have not been implemented yet,\n"
-    "which will be updated later 2024 once our close beta test is ready.\n"
-    "AI for real-world time series is coming. 🚀 Stay tuned please! https://time-series.ai"
-)
-
 
 class TimeSeriesAI:
     def __init__(self):
@@ -22,3 +16,8 @@ def __init__(self):
 class Gungnir(TimeSeriesAI):
     def __init__(self):
         super().__init__()
+        logger.info(
+            "The functionalities of client Gungnir have not been implemented yet,\n"
+            "which will be updated later 2024 once our close beta test is ready.\n"
+            "AI for real-world time series is coming. 🚀 Stay tuned please! https://time-series.ai"
+        )