Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix failed docs building, update the docs, and allow tests for CLI to fail #89

Merged
merged 6 commits into from
May 5, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs: update docs;
  • Loading branch information
WenjieDu committed May 5, 2023
commit 2ddc5b4b05048cfb5a90b895cab3655a3bbae396
12 changes: 3 additions & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ Welcome to PyPOTS docs!

-----------------


⦿ `Motivation`: Due to all kinds of reasons like failure of collection sensors, communication error, and unexpected malfunction, missing values are common to see in time series from the real-world environment. This makes partially-observed time series (POTS) a pervasive problem in open-world modeling and prevents advanced 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 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 have unified APIs together with detailed documentation and interactive examples across algorithms as tutorials.
Expand All @@ -96,17 +97,10 @@ The rest of this readme file is organized as follows:

❖ Installation
^^^^^^^^^^^^^^^
PyPOTS now is available on `Anaconda <https://anaconda.org/conda-forge/pypots>`_ ❗️

Install it with ``conda install pypots``, you may need to specify the channel with option ``-c conda-forge``

Install the latest release from PyPI:

pip install pypots
PyPOTS is available on both `PyPI <https://pypi.python.org/pypi/pypots>`_ and `Anaconda <https://anaconda.org/conda-forge/pypots>`_ ❗️

or install from the source code with the latest features not officially released in a version:
Refer to the page `Installation <install.html>`_ to see how to install PyPOTS.

pip install https://github.com/WenjieDu/PyPOTS/archive/main.zip

❖ Usage
^^^^^^^^
Expand Down
9 changes: 4 additions & 5 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,19 @@ It is recommended to use **pip** or **conda** for PyPOTS installation as shown b

# by pip
pip install pypots # the first time installation
pip install --upgrade pypots # update pypots if needed
pip install --upgrade pypots # update pypots to the latest version

.. code-block:: bash

# by conda
conda install -c conda-forge pypots
conda install -c conda-forge pypots # the first time installation
conda update -c conda-forge pypots # update pypots to the latest version

Alternatively, you can install from the latest source code which may be not officially released yet:

.. code-block:: bash

git clone https://github.com/WenjieDu/PyPOTS PyPOTS_latest --depth 1
cd PyPOTS_latest
pip install .
pip install https://github.com/WenjieDu/PyPOTS/archive/main.zip

Required Dependencies
"""""""""""""""""""""
Expand Down
3 changes: 0 additions & 3 deletions docs/pypots.classification.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
pypots.classification package
=============================

Submodules
----------

pypots.classification.base module
---------------------------------

Expand Down
3 changes: 0 additions & 3 deletions docs/pypots.clustering.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
pypots.clustering package
=========================

Submodules
----------

pypots.clustering.base module
-----------------------------

Expand Down
30 changes: 0 additions & 30 deletions docs/pypots.data.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
pypots.data package
===================

Submodules
----------

pypots.data.base module
-----------------------

Expand All @@ -13,33 +10,6 @@ pypots.data.base module
:show-inheritance:
:inherited-members:

pypots.data.dataset\_for\_brits module
--------------------------------------

.. automodule:: pypots.data.dataset_for_brits
:members:
:undoc-members:
:show-inheritance:
:inherited-members:

pypots.data.dataset\_for\_grud module
-------------------------------------

.. automodule:: pypots.data.dataset_for_grud
:members:
:undoc-members:
:show-inheritance:
:inherited-members:

pypots.data.dataset\_for\_mit module
------------------------------------

.. automodule:: pypots.data.dataset_for_mit
:members:
:undoc-members:
:show-inheritance:
:inherited-members:

pypots.data.generating module
-----------------------------

Expand Down
3 changes: 0 additions & 3 deletions docs/pypots.forecasting.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
pypots.forecasting package
==========================

Submodules
----------

pypots.forecasting.base module
------------------------------

Expand Down
3 changes: 0 additions & 3 deletions docs/pypots.imputation.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
pypots.imputation package
=========================

Submodules
----------

pypots.imputation.base module
-----------------------------

Expand Down
1 change: 1 addition & 0 deletions docs/pypots.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Subpackages
:maxdepth: 4

pypots.classification
pypots.cli
pypots.clustering
pypots.data
pypots.forecasting
Expand Down
12 changes: 9 additions & 3 deletions docs/pypots.utils.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
pypots.utils package
====================

Submodules
----------

pypots.utils.files module
-------------------------

Expand Down Expand Up @@ -31,6 +28,15 @@ pypots.utils.metrics module
:show-inheritance:
:inherited-members:

pypots.utils.random module
--------------------------

.. automodule:: pypots.utils.random
:members:
:undoc-members:
:show-inheritance:
:inherited-members:

Module contents
---------------

Expand Down