Skip to content

Commit

Permalink
Update docs (#489)
Browse files Browse the repository at this point in the history
  • Loading branch information
WenjieDu authored Aug 13, 2024
1 parent 05bed2e commit ec13869
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 3 deletions.
6 changes: 3 additions & 3 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
2 changes: 2 additions & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -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生态系统中,一切都与我们熟悉的咖啡息息相关,甚至可以将其视为一杯咖啡的诞生过程!
Expand Down
3 changes: 3 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit ec13869

Please sign in to comment.