From 13f2caf4d4ba60fc7d79e7ff73e333a07f36db79 Mon Sep 17 00:00:00 2001 From: Wenjie Du Date: Tue, 19 Mar 2024 17:03:50 +0800 Subject: [PATCH] docs: update the docs; --- README.md | 7 ++++--- docs/examples.rst | 4 ++-- docs/index.rst | 27 +++++++++++++++++---------- 3 files changed, 23 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d7281f31..179de9d3 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@

- Python version + Python version powered by Pytorch @@ -144,7 +144,7 @@ Alternatively, you can install from the latest source code with the latest featu ## ❖ Usage Besides [BrewPOTS](https://github.com/WenjieDu/BrewPOTS), you can also find a simple and quick-start tutorial notebook -on Google Colab with [this link](https://colab.research.google.com/drive/1HEFjylEy05-r47jRy0H9jiS_WhD0UWmQ?usp=sharing). +on Google Colab Colab tutorials. If you have further questions, please refer to PyPOTS documentation [docs.pypots.com](https://docs.pypots.com). You can also [raise an issue](https://github.com/WenjieDu/PyPOTS/issues) or [ask in our community](#-community). @@ -265,7 +265,8 @@ By committing your code, you'll Take a look at our [inclusion criteria](https://docs.pypots.com/en/latest/faq.html#inclusion-criteria). You can utilize the `template` folder in each task package (e.g. [pypots/imputation/template](https://github.com/WenjieDu/PyPOTS/tree/main/pypots/imputation/template)) to quickly start; -2. be listed as one of [PyPOTS contributors](https://pypots.com/about/#all-contributors); +2. become one of [PyPOTS contributors](https://github.com/WenjieDu/PyPOTS/graphs/contributors) and + be listed as a volunteer developer [on the PyPOTS website](https://pypots.com/about/#volunteer-developers); 3. get mentioned in our [release notes](https://github.com/WenjieDu/PyPOTS/releases); You can also contribute to PyPOTS by simply staring🌟 this repo to help more people notice it. diff --git a/docs/examples.rst b/docs/examples.rst index 69fd6a28..4e4dd421 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -10,11 +10,11 @@ Quick-start Examples We put some examples here to help our users to get started quickly. Please refer to `BrewPOTS `_ for detailed PyPOTS tutorials. -You can also find a simple and quick-start tutorial notebook on Google Colab with -`this link `_. +You can also find a simple and quick-start tutorial notebook on Google Colab .. raw:: html +
diff --git a/docs/index.rst b/docs/index.rst index 93b84fb9..de4f61ab 100644 --- 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-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 @@ -88,12 +88,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: `❖ PyPOTS Ecosystem <#id1>`_, -`❖ Installation <#id2>`_, -`❖ Usage <#id4>`_, -`❖ Available Algorithms <#id6>`_, -`❖ Citing PyPOTS <#id19>`_, -`❖ Contribution <#id20>`_, -`❖ Community <#id21>`_. +`❖ Installation <#id3>`_, +`❖ Usage <#id5>`_, +`❖ Available Algorithms <#id7>`_, +`❖ Citing PyPOTS <#id22>`_, +`❖ Contribution <#id23>`_, +`❖ Community <#id24>`_. ❖ PyPOTS Ecosystem @@ -136,7 +136,13 @@ Considering the future workload, PyPOTS tutorials is released in a single repo, and you can find them in `BrewPOTS `_. Take a look at it now, and learn how to brew your POTS datasets! -β˜•οΈ Welcome to the universe of PyPOTS. Enjoy it and have fun! +**β˜•οΈ Welcome to the universe of PyPOTS. Enjoy it and have fun!** + +.. image:: https://pypots.com/figs/pypots_logos/Ecosystem/PyPOTS_Ecosystem_Pipeline.png + :width: 95% + :alt: BrewPOTS logo + :align: center + :target: https://pypots.com/ecosystem/ ❖ Installation @@ -149,7 +155,7 @@ Refer to the page `Installation `_ to see different ways of instal ❖ Usage ^^^^^^^^ Besides `BrewPOTS `_, you can also find a simple and quick-start tutorial notebook -on Google Colab with `this link `_. +on Google Colab with `this link `_. You can also `raise an issue `_ or `ask in our community <#id21>`_. Additionally, we present you a usage example of imputing missing values in time series with PyPOTS in @@ -227,7 +233,8 @@ By committing your code, you'll Take a look at our `inclusion criteria `_. You can utilize the ``template`` folder in each task package (e.g. `pypots/imputation/template `_) to quickly start; -2. be listed as one of `PyPOTS contributors `_: +2. become one of `PyPOTS contributors `_ and + be listed as a volunteer developer `on the PyPOTS website `_; 3. get mentioned in our `release notes `_; You can also contribute to PyPOTS by simply staring🌟 this repo to help more people notice it.