Fixing the bug caused by changed tsdb api, updating the docs

.github/PULL_REQUEST_TEMPLATE.md

@@ -12,7 +12,7 @@ Once you're done, I will review your PR shortly. I may suggest changes to make t
 
 <!-- Remove if not applicable -->
 
-Fixes # (issue)
+Fixing # (issue)
 
 
 ## Before submitting

.github/workflows/greetings.yml

@@ -4,7 +4,7 @@ on:
   issues:
     types: [opened]
   pull_request:
-    branches: [main]
+    branches: [main, dev]
     types: [opened]
 
 jobs:

.github/workflows/linting.yml

@@ -7,7 +7,6 @@ on:
             - dev
     pull_request:
         branches:
-            - main
             - dev
 
 jobs:

README.md

@@ -1,5 +1,5 @@
 <a href="https://github.com/WenjieDu/PyPOTS">
-    <img src="https://raw.githubusercontent.com/WenjieDu/PyPOTS/main/docs/_static/figs/PyPOTS_logo.svg?sanitize=true" width="200" align="right">
+    <img src="https://raw.githubusercontent.com/PyPOTS/pypots.github.io/main/static/figs/pypots_logos/PyPOTS_logo_FFBG.svg?sanitize=true" width="200" align="right">
 </a>
 
 ## <p align="center">Welcome to PyPOTS</p>
@@ -66,15 +66,15 @@ have unified APIs together with detailed documentation and interactive examples
 if it helps with your research. This really means a lot to our open-source research. Thank you!
 
 <a href="https://github.com/WenjieDu/TSDB">
-    <img src="https://raw.githubusercontent.com/WenjieDu/TSDB/main/docs/_static/figs/TSDB_logo.svg?sanitize=true" align="left" width="160" alt="TSDB logo"/>
+    <img src="https://raw.githubusercontent.com/PyPOTS/pypots.github.io/main/static/figs/pypots_logos/TSDB_logo_FFBG.svg?sanitize=true" align="left" width="160" alt="TSDB logo"/>
 </a>
 
 To make various open-source time-series datasets readily available to our users,
 PyPOTS gets supported by its subproject [TSDB (Time-Series Data Base)](https://github.com/WenjieDu/TSDB),
 a toolbox making loading time-series datasets super easy!
 
 Visit [TSDB](https://github.com/WenjieDu/TSDB) right now to know more about this handy tool 🛠!
-It now supports a total of 119 open-source datasets.
+It now supports a total of 168 open-source datasets.
 <br clear="left">
 
 The rest of this readme file is organized as follows:
@@ -108,7 +108,7 @@ Alternatively, you can install from the latest source code with the latest featu
 
 ## ❖ Usage
 <a href="https://github.com/WenjieDu/BrewPOTS">
-    <img src="https://raw.githubusercontent.com/WenjieDu/BrewPOTS/main/figs/BrewPOTS_logo.jpg" align="left" width="160" alt="BrewPOTS logo"/>
+    <img src="https://raw.githubusercontent.com/PyPOTS/pypots.github.io/main/static/figs/pypots_logos/BrewPOTS_logo_FFBG.svg?sanitize=true" align="left" width="160" alt="BrewPOTS logo"/>
 </a>
 
 PyPOTS tutorials have been released. Considering the future workload, I separate the tutorials into a single repo,

docs/about_us.rst

@@ -12,14 +12,20 @@ Wenjie Du
 
 Maciej Skrabski
 ***************
-- Joined as a maintainer in May 2023
+- Joined in May 2023
 - `GitHub (MaciejSkrabski) <https://github.com/MaciejSkrabski>`_
 - `LinkedIn (Maciej Skrabski) <https://www.linkedin.com/in/maciej-skrabski-75595525a>`_
 
+Jun Wang
+********
+- Joined in August 2023
+- `GitHub (AugustJW) <https://github.com/AugustJW>`_
+- `LinkedIn (Jun Wang) <https://www.linkedin.com/in/wang-jun-35323b193>`_
+
 
 All Contributors
 """"""""""""""""
-PyPOTS exists thanks to all the nice people who contribute their time to work on the project (including the repositories
+PyPOTS exists thanks to all the nice people (sorted by contribution time) who contribute their time to work on the project (including the repositories
 `PyPOTS <https://github.com/WenjieDu/PyPOTS/graphs/contributors>`_,
 `BrewPOTS <https://github.com/WenjieDu/BrewPOTS/graphs/contributors>`_,
 `TSDB <https://github.com/WenjieDu/TSDB/graphs/contributors>`_,

docs/conf.py

@@ -102,7 +102,10 @@
     "last_updated": f"{date_now.year}/{date_now.month}/{date_now.day}",
 }
 
-html_favicon = "_static/figs/PyPOTS_logo.svg"
+html_favicon = (
+    "https://raw.githubusercontent.com/"
+    "PyPOTS/pypots.github.io/main/static/figs/pypots_logos/PyPOTS_logo_FFBG.svg"
+)
 
 html_sidebars = {
     "**": [

docs/examples.rst

@@ -1,7 +1,7 @@
 Quick-start Examples
 ====================
 
-.. image:: https://raw.githubusercontent.com/WenjieDu/BrewPOTS/main/figs/BrewPOTS_logo.jpg
+.. image:: https://raw.githubusercontent.com/PyPOTS/pypots.github.io/main/static/figs/pypots_logos/BrewPOTS_logo_FFBG.svg?sanitize=true
    :width: 160
    :alt: BrewPOTS logo
    :align: right

docs/faq.rst

@@ -11,6 +11,7 @@ published for at least 1 year, have 20+ citations, and the usefulness to our use
 to help boost research accessibility and reproducibility in the field of POTS modeling.
 Note this exception only applies if you commit to the maintenance of your model for at least two years.
 
+
 Join PyPOTS
 ^^^^^^^^^^^^^^^^^^^^^
 Becoming a Maintainer
@@ -40,10 +41,12 @@ Becoming a Lead
 """""""""""""""
 To become a lead at PyPOTS, surely you have to already obtain a maintainer role first.
 Your research should be highly related to data mining/machine learning on POTS data, and
-you have to prove that you're capable of proposing a research plan solely and conducting it.
+you need to prove that you're capable of proposing a research plan solely and conducting it.
 You're willing to take developing PyPOTS as your responsibility and commit to constantly and regularly
 contribute you time and ideas to PyPOTS things (including community culture construction,
 code maintenance, current research implementation, new research planning).
+The lead is a permanent role unless your research is no longer related to the field of modeling POTS or
+you no longer want to get involved with affairs at PyPOTS.
 
 If you believe you want to do this, you can drop an email with anything you want to tell and your CV attachment to
 `[email protected] <mailto:[email protected]>`_. We will schedule a meeting for you and all other leads at PyPOTS for further discussion.

docs/index.rst

@@ -4,7 +4,7 @@
 
 Welcome to PyPOTS docs!
 ===============================
-.. image:: https://raw.githubusercontent.com/WenjieDu/PyPOTS/main/docs/_static/figs/PyPOTS_logo.svg?sanitize=true
+.. image:: https://raw.githubusercontent.com/PyPOTS/pypots.github.io/main/static/figs/pypots_logos/PyPOTS_logo_FFBG.svg?sanitize=true
    :height: 168
    :align: right
    :target: https://github.com/WenjieDu/PyPOTS
@@ -80,15 +80,15 @@ Welcome to PyPOTS docs!
 **Please** properly `cite PyPOTS <https://docs.pypots.com/en/latest/milestones.html#citing-pypots>`_ in your publications
 if it helps with your research. This really means a lot to our open-source research. Thank you!
 
-.. image:: https://raw.githubusercontent.com/WenjieDu/TSDB/main/docs/_static/figs/TSDB_logo.svg?sanitize=true
+.. image:: https://raw.githubusercontent.com/PyPOTS/pypots.github.io/main/static/figs/pypots_logos/TSDB_logo_FFBG.svg?sanitize=true
    :width: 170
    :alt: TSDB
    :align: left
    :target: https://github.com/WenjieDu/TSDB
 
 To make various open-source time-series datasets readily available to our users, PyPOTS gets supported by its sub-project `TSDB (Time-Series Data Base) <https://github.com/WenjieDu/TSDB>`_, a toolbox making loading time-series datasets super easy!
 
-Visit `TSDB <https://github.com/WenjieDu/TSDB>`_ right now to know more about this handy tool 🛠! It now supports a total of 119 open-source datasets.
+Visit `TSDB <https://github.com/WenjieDu/TSDB>`_ right now to know more about this handy tool 🛠! It now supports a total of 168 open-source datasets.
 
 The rest of this readme file is organized as follows:
 `❖ Installation <#id1>`_,
@@ -108,7 +108,7 @@ Refer to the page `Installation <install.html>`_ to see different ways of instal
 
 ❖ Usage
 ^^^^^^^^
-.. image:: https://raw.githubusercontent.com/WenjieDu/BrewPOTS/main/figs/BrewPOTS_logo.jpg
+.. image:: https://raw.githubusercontent.com/PyPOTS/pypots.github.io/main/static/figs/pypots_logos/BrewPOTS_logo_FFBG.svg?sanitize=true
    :width: 160
    :alt: BrewPOTS logo
    :align: left

pypots/base.py

@@ -13,7 +13,7 @@
 import torch
 from torch.utils.tensorboard import SummaryWriter
 
-from .utils.files import create_dir_if_not_exist
+from .utils.file import create_dir_if_not_exist
 from .utils.logging import logger
 
 

pypots/cli/doc.py

@@ -9,7 +9,7 @@
 import shutil
 from argparse import Namespace
 
-from tsdb.data_processing import _download_and_extract
+from tsdb.utils.downloading import _download_and_extract
 
 from ..cli.base import BaseCommand
 from ..utils.logging import logger

pypots/utils/__init__.py

@@ -8,7 +8,7 @@
 
 __all__ = [
     # content files in this package
-    "files",
+    "file.py",
     "logging",
     "metrics",
     "random",

pypots/utils/metrics.py

@@ -54,7 +54,7 @@ def cal_mae(
     so the result is 1/2=0.5.
 
     """
-    assert type(predictions) == type(targets), (
+    assert isinstance(predictions, type(targets)), (
         f"types of inputs and target must match, but got"
         f"type(inputs)={type(predictions)}, type(target)={type(targets)}"
     )
@@ -110,7 +110,7 @@ def cal_mse(
 
     """
 
-    assert type(predictions) == type(targets), (
+    assert isinstance(predictions, type(targets)), (
         f"types of inputs and target must match, but got"
         f"type(inputs)={type(predictions)}, type(target)={type(targets)}"
     )
@@ -166,7 +166,7 @@ def cal_rmse(
     so the result is :math:`\\sqrt{1/2}=0.5`.
 
     """
-    assert type(predictions) == type(targets), (
+    assert isinstance(predictions, type(targets)), (
         f"types of inputs and target must match, but got"
         f"type(inputs)={type(predictions)}, type(target)={type(targets)}"
     )
@@ -217,7 +217,7 @@ def cal_mre(
     so the result is :math:`\\sqrt{1/2}=0.5`.
 
     """
-    assert type(predictions) == type(targets), (
+    assert isinstance(predictions, type(targets)), (
         f"types of inputs and target must match, but got"
         f"type(inputs)={type(predictions)}, type(target)={type(targets)}"
     )