diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0304d846..416976ed 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.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 -Fixes # (issue) +Fixing # (issue) ## Before submitting diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml index 42d60038..188c94aa 100644 --- a/.github/workflows/greetings.yml +++ b/.github/workflows/greetings.yml @@ -4,7 +4,7 @@ on: issues: types: [opened] pull_request: - branches: [main] + branches: [main, dev] types: [opened] jobs: diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml index c28fbc85..4aca2b57 100644 --- a/.github/workflows/linting.yml +++ b/.github/workflows/linting.yml @@ -7,7 +7,6 @@ on: - dev pull_request: branches: - - main - dev jobs: diff --git a/README.md b/README.md index 3faac146..56df9e5d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ - + ##

Welcome to PyPOTS

@@ -66,7 +66,7 @@ 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! - TSDB logo + TSDB logo To make various open-source time-series datasets readily available to our users, @@ -74,7 +74,7 @@ PyPOTS gets supported by its subproject [TSDB (Time-Series Data Base)](https://g 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.
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 - BrewPOTS logo + BrewPOTS logo PyPOTS tutorials have been released. Considering the future workload, I separate the tutorials into a single repo, diff --git a/docs/_static/figs/PyPOTS_logo.jpg b/docs/_static/figs/PyPOTS_logo.jpg deleted file mode 100644 index 50ed88d8..00000000 Binary files a/docs/_static/figs/PyPOTS_logo.jpg and /dev/null differ diff --git a/docs/_static/figs/PyPOTS_logo.svg b/docs/_static/figs/PyPOTS_logo.svg deleted file mode 100644 index 50bfc53b..00000000 --- a/docs/_static/figs/PyPOTS_logo.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
 \texttt{PyPOT}Text is not SVG - cannot display \ No newline at end of file diff --git a/docs/about_us.rst b/docs/about_us.rst index bfbebd2d..aaaab944 100644 --- a/docs/about_us.rst +++ b/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) `_ - `LinkedIn (Maciej Skrabski) `_ +Jun Wang +******** +- Joined in August 2023 +- `GitHub (AugustJW) `_ +- `LinkedIn (Jun Wang) `_ + 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 `_, `BrewPOTS `_, `TSDB `_, diff --git a/docs/conf.py b/docs/conf.py index 8e98ae00..1dff9c8a 100644 --- a/docs/conf.py +++ b/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 = { "**": [ diff --git a/docs/examples.rst b/docs/examples.rst index bc79a133..2e43f2c8 100644 --- a/docs/examples.rst +++ b/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 diff --git a/docs/faq.rst b/docs/faq.rst index 3c10480d..3999843f 100644 --- a/docs/faq.rst +++ b/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 `team@pypots.com `_. We will schedule a meeting for you and all other leads at PyPOTS for further discussion. diff --git a/docs/index.rst b/docs/index.rst index 63a7be3c..6254b4c5 100644 --- a/docs/index.rst +++ b/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,7 +80,7 @@ Welcome to PyPOTS docs! **Please** properly `cite 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 @@ -88,7 +88,7 @@ if it helps with your research. This really means a lot to our open-source resea 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) `_, a toolbox making loading time-series datasets super easy! -Visit `TSDB `_ right now to know more about this handy tool 🛠! It now supports a total of 119 open-source datasets. +Visit `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 `_ 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 diff --git a/pypots/base.py b/pypots/base.py index ad11eda7..f55033e3 100644 --- a/pypots/base.py +++ b/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 diff --git a/pypots/cli/doc.py b/pypots/cli/doc.py index a5985497..2e0e6b5a 100644 --- a/pypots/cli/doc.py +++ b/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 diff --git a/pypots/utils/__init__.py b/pypots/utils/__init__.py index 1376524d..5fd28d97 100644 --- a/pypots/utils/__init__.py +++ b/pypots/utils/__init__.py @@ -8,7 +8,7 @@ __all__ = [ # content files in this package - "files", + "file.py", "logging", "metrics", "random", diff --git a/pypots/utils/files.py b/pypots/utils/file.py similarity index 100% rename from pypots/utils/files.py rename to pypots/utils/file.py diff --git a/pypots/utils/metrics.py b/pypots/utils/metrics.py index 058cc24a..ee7d69bb 100644 --- a/pypots/utils/metrics.py +++ b/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)}" )