docs: update docs;

WenjieDu · May 29, 2023 · a68ee50 · a68ee50
1 parent d4a98b3
commit a68ee50
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -53,7 +53,7 @@ This makes partially-observed time series (POTS) a pervasive problem in open-wor
 data analysis. Although this problem is important, the area of data mining on POTS still lacks a dedicated toolkit.
 PyPOTS is created to fill in this blank.
 
-⦿ `Mission`: PyPOTS is born to become a handy toolbox that is going to make data mining on POTS easy rather than
+⦿ `Mission`: PyPOTS (pronounced "Pie Pots") is born to become a handy toolbox that is going to make data mining on POTS easy rather than
 tedious, to help engineers and researchers focus more on the core problems in their hands rather than on how to deal
 with the missing parts in their data. PyPOTS will keep integrating classical and the latest state-of-the-art data mining
 algorithms for partially-observed multivariate time series. For sure, besides various algorithms, PyPOTS is going to
@@ -238,15 +238,6 @@ If you have any suggestions or want to contribute ideas or share time-series rel
 PyPOTS community is open, transparent, and surely friendly. Let's work together to build and improve PyPOTS 💪!
 
 
-## ❖ Attention 👀
-‼️ PyPOTS is currently under developing. If you like it and look forward to its growth, <ins>please give PyPOTS a star
-and watch it to keep you posted on its progress and to let me know that its development is meaningful</ins>.
-If you have any additional questions or have interests in collaboration, please take a look at
-[my GitHub profile](https://github.com/WenjieDu) and feel free to contact me 🤝.
-
-Thank you all for your attention! 😃
-
-
 [^1]: Du, W., Cote, D., & Liu, Y. (2023). [SAITS: Self-Attention-based Imputation for Time Series](https://doi.org/10.1016/j.eswa.2023.119619). *Expert systems with applications*.
 [^2]: Vaswani, A., Shazeer, N.M., Parmar, N., Uszkoreit, J., Jones, L., Gomez, A.N., Kaiser, L., & Polosukhin, I. (2017). [Attention is All you Need](https://papers.nips.cc/paper/2017/hash/3f5ee243547dee91fbd053c1c4a845aa-Abstract.html). *NeurIPS 2017*.
 [^3]: Cao, W., Wang, D., Li, J., Zhou, H., Li, L., & Li, Y. (2018). [BRITS: Bidirectional Recurrent Imputation for Time Series](https://papers.nips.cc/paper/2018/hash/734e6bfcd358e25ac1db0a4241b95651-Abstract.html). *NeurIPS 2018*.

diff --git a/docs/faq.rst b/docs/faq.rst
@@ -20,9 +20,10 @@ To become a maintainer of PyPOTS, you should
 2. watch the repository to receive latest news from it;
 3. be familiar with the PyPOTS codebase;
 4. and have made at least one pull request merged into branch ``main`` of PyPOTS,
-   which is not for fixing typos or improving the docs.
-5. join the PyPOTS community on Slack and become a member of the channel ``#dev-team``.
-   ``#dev-team`` currently is a public channel, and you don't need an invitation to join it.
+   which is not for fixing typos or improving the docs;
+5. join the `PyPOTS community on Slack <https://join.slack.com/t/pypots-org/shared_invite/zt-1gq6ufwsi-p0OZdW~e9UW_IA4_f1OfxA>`_
+   and become a member of the channel ``#dev-team``. ``#dev-team`` currently is a public channel, and you don't need an invitation to join it.
+6. commit to obey our development principles;
 
 After meeting up with the above conditions,
 you can propose to get a maintainer role by dropping an email to `[email protected] <mailto:[email protected]>`_.
@@ -31,3 +32,14 @@ Once you obtain the role, you'll be listed as a member on the ``About Us`` pages
 `PyPOTS main site <https://pypots.com/about/>`_
 and
 `PyPOTS docs site <https://docs.pypots.com/en/latest/about_us.html>`_.
+
+
+Our Development Principles
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+1. `Do one thing and do it well (Unix philosophy) <https://en.wikipedia.org/wiki/Unix_philosophy#Do_One_Thing_and_Do_It_Well>`_.
+   We're PyPOTS: we don't build everything related to time series and we don't have to, but only things related to partially-observed time series.
+   And when we build something in PyPOTS, we're responsible and trying our best to do it well;
+2. `Eat our own dog food <https://en.wikipedia.org/wiki/Eating_your_own_dog_food>`_.
+   We develop PyPOTS and we should try the best to use it in any scenarios related to POTS data.
+   Only in this way, we can figure out how it tastes like, if it is a good toolset for users, and what other features and models should be included into PyPOTS;
+3. ``
diff --git a/docs/index.rst b/docs/index.rst
@@ -137,7 +137,6 @@ Clustering                     Neural Network   VaDER (Variational Deep Embeddin
 Forecasting                    Probabilistic    BTTF (Bayesian Temporal Tensor Factorization)                              2021   :cite:`chen2021BTMF`
 ============================== ================ =========================================================================  ====== =========
 
-[^9]: Yoon, J., Zame, W. R., & van der Schaar, M. (2019). [Estimating Missing Data in Temporal Data Streams Using Multi-Directional Recurrent Neural Networks](https://ieeexplore.ieee.org/document/8485748). *IEEE Transactions on Biomedical Engineering*.
 
 ❖ Citing PyPOTS
 ^^^^^^^^^^^^^^^^
@@ -206,16 +205,6 @@ If you have any suggestions or want to contribute ideas or share time-series rel
 PyPOTS community is open, transparent, and surely friendly. Let's work together to build and improve PyPOTS 💪!
 
 
-❖ Attention 👀
-^^^^^^^^^^^^^^^
-PyPOTS is currently under developing. If you like it and look forward to its growth, **please give PyPOTS a star
-and watch it to keep you posted on its progress and to let me know that its development is meaningful**.
-If you have any additional questions or have interests in collaboration, please take a look at
-`my GitHub profile <https://github.com/WenjieDu>`_ and feel free to contact me 🤝.
-
-Thank you all for your attention! 😃
-
-
 .. toctree::
    :maxdepth: 2
    :hidden: