Skip to content

Commit

Permalink
Update docs (#493)
Browse files Browse the repository at this point in the history
  • Loading branch information
WenjieDu authored Aug 14, 2024
1 parent cc4b435 commit f5ab63e
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 26 deletions.
1 change: 1 addition & 0 deletions .github/workflows/testing_ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ jobs:
- name: Submit the report
uses: coverallsapp/github-action@master
continue-on-error: true
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
path-to-lcov: "coverage.lcov"
1 change: 1 addition & 0 deletions .github/workflows/testing_daily.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ jobs:
- name: Submit the report
uses: coverallsapp/github-action@master
continue-on-error: true
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
path-to-lcov: 'coverage.lcov'
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@
<a href="https://github.com/WenjieDu/PyPOTS/blob/main/README.md">
<img alt="README in English" src="https://pypots.com/figs/pypots_logos/readme/US.svg">
</a>
<a href="https://github.com/WenjieDu/PyPOTS">
<img alt="PyPOTS Hits" src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FPyPOTS%2FPyPOTS&count_bg=%23009A0A&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=Hits&edge_flat=false">
</a>
</p>

⦿ `Motivation`: Due to all kinds of reasons like failure of collection sensors, communication error,
Expand Down Expand Up @@ -391,11 +394,3 @@ PyPOTS community is open, transparent, and surely friendly. Let's work together
[^35]: Bai, S., Kolter, J. Z., & Koltun, V. (2018). [An empirical evaluation of generic convolutional and recurrent networks for sequence modeling](https://arxiv.org/abs/1803.01271). *arXiv 2018*.
[^36]: Project Gungnir, the world 1st LLM for time-series multitask modeling, will meet you soon. 🚀 Missing values and variable lengths in your datasets?
Hard to perform multitask learning with your time series? Not problems no longer. We'll open application for public beta test recently ;-) Follow us, and stay tuned!

<details>
<summary>🏠 Visits</summary>
<a href="https://github.com/WenjieDu/PyPOTS">
<img alt="PyPOTS visits" align="left" src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FPyPOTS%2FPyPOTS&count_bg=%23009A0A&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=Visits%20since%20May%202022&edge_flat=false">
</a>
</details>
<br>
11 changes: 3 additions & 8 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@
<a href="https://github.com/WenjieDu/PyPOTS/blob/main/README_zh.md">
<img alt="README in Chinese" src="https://pypots.com/figs/pypots_logos/readme/CN.svg">
</a>
<a href="https://github.com/WenjieDu/PyPOTS">
<img alt="PyPOTS Hits" src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FPyPOTS%2FPyPOTS&count_bg=%23009A0A&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=Hits&edge_flat=false">
</a>
</p>

⦿ `开发背景`: 由于传感器故障、通信异常以及不可预见的未知原因,在现实环境中收集的时间序列数据普遍存在缺失值,
Expand Down Expand Up @@ -360,11 +363,3 @@ PyPOTS社区是一个开放、透明、友好的社区,让我们共同努力
[^34]: Nie, T., Qin, G., Mei, Y., & Sun, J. (2024). [ImputeFormer: Low Rankness-Induced Transformers for Generalizable Spatiotemporal Imputation](https://arxiv.org/abs/2312.01728). *KDD 2024*.
[^35]: Bai, S., Kolter, J. Z., & Koltun, V. (2018). [An empirical evaluation of generic convolutional and recurrent networks for sequence modeling](https://arxiv.org/abs/1803.01271). *arXiv 2018*.
[^36]: Gungnir项目,世界上第一个时间序列多任务大模型,将很快与大家见面。🚀 数据集存在缺少值且样本长短不一?多任务建模场景困难?都不再是问题,让我们的大模型来帮你解决。我们将在近期开放公测申请 ;-) 关注我们,敬请期待!

<details>
<summary>🏠 访问量</summary>
<a href="https://github.com/WenjieDu/PyPOTS">
<img alt="PyPOTS访问量" align="left" src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FPyPOTS%2FPyPOTS&count_bg=%23009A0A&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=自从2022年5月以来的访问量&edge_flat=false">
</a>
</details>
<br>
18 changes: 9 additions & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ Welcome to PyPOTS docs!
:alt: README in English
:target: https://github.com/WenjieDu/PyPOTS/blob/main/README.md

.. image:: https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FPyPOTS%2FPyPOTS&count_bg=%23009A0A&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=Visits%20since%20May%202022&edge_flat=false
:alt: Visiting number
.. image:: https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FPyPOTS%2FPyPOTS&count_bg=%23009A0A&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=Hits&edge_flat=false
:alt: Hits number

-----------------

Expand All @@ -101,12 +101,12 @@ if it helps with your research. This really means a lot to our open-source resea

The rest of this readme file is organized as follows:
`❖ Available Algorithms <#id1>`_,
`❖ PyPOTS Ecosystem <#id22>`_,
`❖ Installation <#id24>`_,
`❖ Usage <#id26>`_,
`❖ Citing PyPOTS <#id28>`_,
`❖ Contribution <#id29>`_,
`❖ Community <#id30>`_.
`❖ PyPOTS Ecosystem <#id37>`_,
`❖ Installation <#id39>`_,
`❖ Usage <#id41>`_,
`❖ Citing PyPOTS <#id43>`_,
`❖ Contribution <#id44>`_,
`❖ Community <#id45>`_.


❖ Available Algorithms
Expand Down Expand Up @@ -212,7 +212,7 @@ The paper references are all listed at the bottom of this readme file.

💯 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.
Refer to the `contribution guide <#id44>`_ to see how to include your model in PyPOTS.

❖ PyPOTS Ecosystem
^^^^^^^^^^^^^^^^^^^
Expand Down
3 changes: 2 additions & 1 deletion docs/milestones.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,5 @@ 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>`_;
- 2024-07: PyPOTS achieves its first 300,000 downloads in total;
- 2024-08: We present the keynote "Learning from Partially Observed Time Series: Towards Reality-Centric AI4TS" `IJCAI'24 AI4TS workshop <https://ai4ts.github.io/ijcai2024>`_;

0 comments on commit f5ab63e

Please sign in to comment.