docs: update docs;

WenjieDu · Nov 27, 2023 · 10408f2 · 10408f2
1 parent e723f05
commit 10408f2
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 47 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 <p align="center">
     <a href="https://docs.pypots.com/en/latest/install.html#reasons-of-version-limitations-on-dependencies">
-       <img alt="Python version" src="https://img.shields.io/badge/Python-v3.7--3.11-E97040?logo=python&logoColor=white">
+       <img alt="Python version" src="https://img.shields.io/badge/Python->=v3.7-E97040?logo=python&logoColor=white">
     </a>
     <a href="https://github.com/WenjieDu/PyPOTS">
         <img alt="powered by Pytorch" src="https://img.shields.io/badge/PyTorch-❤️-F8C6B5?logo=pytorch&logoColor=white">
@@ -40,16 +40,18 @@
     <a href="https://github.com/WenjieDu/PyPOTS/actions/workflows/testing_ci.yml">
         <img alt="GitHub Testing" src="https://img.shields.io/github/actions/workflow/status/wenjiedu/pypots/testing_ci.yml?logo=circleci&color=C8D8E1&label=CI">
     </a>
-    <a href="https://arxiv.org/abs/2305.18811">
-        <img alt="arXiv DOI" src="https://img.shields.io/badge/DOI-10.48550/arXiv.2305.18811-F8F7F0">
+    <a href="https://readthedocs.org/projects/pypots/builds">
+        <img alt="Docs building" src="https://img.shields.io/readthedocs/pypots?logo=readthedocs&label=Docs&logoColor=white&color=395260">
     </a>
     <a href="https://anaconda.org/conda-forge/pypots">
         <img alt="Conda downloads" src="https://img.shields.io/endpoint?url=https://pypots.com/figs/downloads_badges/conda_pypots_downloads.json">
     </a>
     <a href="https://pepy.tech/project/pypots">
         <img alt="PyPI downloads" src="https://img.shields.io/endpoint?url=https://pypots.com/figs/downloads_badges/pypi_pypots_downloads.json">
     </a>
-
+    <a href="https://arxiv.org/abs/2305.18811">
+        <img alt="arXiv DOI" src="https://img.shields.io/badge/DOI-10.48550/arXiv.2305.18811-F8F7F0">
+    </a>
 </p>
 
 ⦿ `Motivation`: Due to all kinds of reasons like failure of collection sensors, communication error,
@@ -238,22 +240,6 @@ doi={10.48550/arXiv.2305.18811},
 > PyPOTS: a Python toolbox for data mining on Partially-Observed Time Series.
 > arXiv, abs/2305.18811.https://arxiv.org/abs/2305.18811
 
-or
-
-``` bibtex
-@inproceedings{du2023PyPOTS,
-title={{PyPOTS: a Python toolbox for data mining on Partially-Observed Time Series}},
-booktitle={9th SIGKDD workshop on Mining and Learning from Time Series (MiLeTS'23)},
-author={Wenjie Du},
-year={2023},
-url={https://arxiv.org/abs/2305.18811},
-}
-```
-
-> Wenjie Du. (2023).
-> PyPOTS: a Python toolbox for data mining on Partially-Observed Time Series.
-> In *9th SIGKDD workshop on Mining and Learning from Time Series (MiLeTS'23)*. https://arxiv.org/abs/2305.18811
-
 
 ## ❖ Contribution
 You're very welcome to contribute to this exciting project!

diff --git a/docs/index.rst b/docs/index.rst
@@ -12,7 +12,7 @@ Welcome to PyPOTS docs!
 
 **A Python Toolbox for Data Mining on Partially-Observed Time Series**
 
-.. image:: https://img.shields.io/badge/Python-v3.7--3.11-E97040?logo=python&logoColor=white
+.. image:: https://img.shields.io/badge/Python->=v3.7-E97040?logo=python&logoColor=white
    :alt: Python version
    :target: https://docs.pypots.com/en/latest/install.html#reasons-of-version-limitations-on-dependencies
 
@@ -56,9 +56,9 @@ Welcome to PyPOTS docs!
    :alt: GitHub Testing
    :target: https://github.com/WenjieDu/PyPOTS/actions/workflows/testing_ci.yml
 
-.. image:: https://img.shields.io/badge/DOI-10.48550/arXiv.2305.18811-F8F7F0
-   :alt: arXiv DOI
-   :target: https://arxiv.org/abs/2305.18811
+.. image:: https://img.shields.io/readthedocs/pypots?logo=readthedocs&label=Docs&logoColor=white&color=395260
+   :alt: Docs building
+   :target: https://readthedocs.org/projects/pypots/builds
 
 .. image:: https://img.shields.io/endpoint?url=https://pypots.com/figs/downloads_badges/conda_pypots_downloads.json
    :alt: Conda downloads
@@ -68,6 +68,10 @@ Welcome to PyPOTS docs!
    :alt: PyPI downloads
    :target: https://pepy.tech/project/pypots
 
+.. image:: https://img.shields.io/badge/DOI-10.48550/arXiv.2305.18811-F8F7F0
+   :alt: arXiv DOI
+   :target: https://arxiv.org/abs/2305.18811
+
 .. 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
 
@@ -210,26 +214,6 @@ please cite it as below and 🌟star `PyPOTS repository <https://github.com/Wenj
    PyPOTS: a Python toolbox for data mining on Partially-Observed Time Series.
    arXiv, abs/2305.18811. https://doi.org/10.48550/arXiv.2305.18811
 
-or
-
-.. code-block:: bibtex
-   :linenos:
-
-   @inproceedings{du2023PyPOTS,
-   title={{PyPOTS: a Python toolbox for data mining on Partially-Observed Time Series}},
-   booktitle={9th SIGKDD workshop on Mining and Learning from Time Series (MiLeTS'23)},
-   author={Wenjie Du},
-   year={2023},
-   url={https://arxiv.org/abs/2305.18811},
-   }
-
-..
-
-   Wenjie Du. (2023).
-   PyPOTS: a Python toolbox for data mining on Partially-Observed Time Series.
-   In *9th SIGKDD workshop on Mining and Learning from Time Series (MiLeTS'23)*. https://arxiv.org/abs/2305.18811
-
-
 
 ❖ Contribution
 ^^^^^^^^^^^^^^^

diff --git a/docs/install.rst b/docs/install.rst
@@ -25,7 +25,7 @@ Alternatively, you can install from the latest source code which may be not offi
 
 Required Dependencies
 """""""""""""""""""""
-* Python >=3.7, <=3.11
+* Python >=3.7
 * numpy
 * scipy
 * scikit-learn
@@ -49,8 +49,7 @@ Reasons of Version Limitations on Dependencies
 * **Why we need python >=3.7?**
 
 Python v3.6 and before versions have no longer been supported officially (check out `status of Python versions here <https://devguide.python.org/versions/>`_).
-Besides, PyG (torch-geometric) is available for Python v3.7 to v3.11 (refer to https://pytorch-geometric.readthedocs.io/en/latest/install/installation.html#installation-via-anaconda ),
-and this is also why we need Python version to be lower than 3.12 so far.
+Besides, PyG (torch-geometric) is available for Python >= v3.7 (refer to https://pytorch-geometric.readthedocs.io/en/latest/install/installation.html#installation-via-anaconda ).
 Although torch-geometric is an optional dependency, we hope things go smoothly when our users opt to install it.
 
 In addition, note that Python v.3.7 has also been in the end-of-life status since 2023-06-27.