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

Update docs #523

Merged
merged 29 commits into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
e9b9b03
docs: update README_zh;
WenjieDu Jun 26, 2024
a385c56
docs: update docs;
WenjieDu Jul 1, 2024
f2c73a5
Merge branch 'dev' into (docs)update
WenjieDu Jul 24, 2024
7a15e04
docs: update the docs;
WenjieDu Jul 24, 2024
a8631ee
docs: update docs;
WenjieDu Jul 25, 2024
04008dc
docs: update the install page;
WenjieDu Jul 26, 2024
4c143c5
docs: add lib logos;
WenjieDu Jul 28, 2024
2acf54d
docs: update docs;
WenjieDu Aug 11, 2024
0ad8c52
Merge branch 'dev' into (docs)update
WenjieDu Aug 11, 2024
0bb727b
fix: try to upgrade doc building env;
WenjieDu Aug 11, 2024
f792204
docs: update docs;
WenjieDu Aug 13, 2024
3570ad7
docs: update milestones;
WenjieDu Aug 13, 2024
94280be
docs: update docs;
WenjieDu Aug 14, 2024
42a93e2
no message
WenjieDu Aug 14, 2024
2d089d3
docs: update docs;
WenjieDu Aug 14, 2024
7b8b55a
docs: update readme files;
WenjieDu Aug 19, 2024
d06187d
docs: update readme files;
WenjieDu Aug 29, 2024
bcec72a
Merge branch 'main' into (docs)update
WenjieDu Aug 29, 2024
e1f3376
docs: update docs;
WenjieDu Sep 3, 2024
942cdb2
docs: add the icon for Jetbrains IDEA;
WenjieDu Sep 3, 2024
c96294a
docs: add TimeMixer docs;
WenjieDu Sep 3, 2024
e8e127c
docs: add TimeMixer into README;
WenjieDu Sep 3, 2024
57d9789
Merge branch 'dev' into (docs)update
WenjieDu Sep 3, 2024
6f6714f
test: make the TimeMixer smaller for a faster test;
WenjieDu Sep 3, 2024
518d9d3
docs: add ModernTCN docs;
WenjieDu Sep 4, 2024
9248576
Merge branch 'dev' into (docs)update
WenjieDu Sep 4, 2024
0923cbb
Merge branch 'dev' into (docs)update
WenjieDu Sep 20, 2024
6f0925a
docs: update docs;
WenjieDu Sep 20, 2024
3b47a1d
docs: update .gitignore and references;
WenjieDu Sep 23, 2024
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
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,8 @@ docs/_build
# ignore specific kinds of files like all PDFs
*.pdf
*.ipynb
*TODO

# ignore executable and config files
*.sh
*.yml
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ algorithms, PyPOTS is going to have unified APIs together with detailed document
algorithms as tutorials.

🤗 **Please** star this repo to help others notice PyPOTS if you think it is a useful toolkit.
**Please** kindly [cite PyPOTS](https://github.com/WenjieDu/PyPOTS#-citing-pypots) in your publications if it helps with your research.
**Please** kindly [cite PyPOTS](https://github.com/WenjieDu/PyPOTS#-citing-pypots) in your publications if it helps with
your research.
This really means a lot to our open-source research. Thank you!

The rest of this readme file is organized as follows:
Expand All @@ -98,9 +99,9 @@ corresponding task (note that models will be continuously updated in the future
currently supported. Stay tuned❗️).

🌟 Since **v0.2**, all neural-network models in PyPOTS has got hyperparameter-optimization support.
This functionality is implemented with the [Microsoft NNI](https://github.com/microsoft/nni) framework. You may want to refer to our time-series
imputation survey repo [Awesome_Imputation](https://github.com/WenjieDu/Awesome_Imputation) to see how to config and
tune the hyperparameters.
This functionality is implemented with the [Microsoft NNI](https://github.com/microsoft/nni) framework. You may want to
refer to our time-series imputation survey repo [Awesome_Imputation](https://github.com/WenjieDu/Awesome_Imputation)
to see how to config and tune the hyperparameters.

🔥 Note that all models whose name with `🧑‍🔧` in the table (e.g. Transformer, iTransformer, Informer etc.) are not
originally proposed as algorithms for POTS data in their papers, and they cannot directly accept time series with
Expand Down Expand Up @@ -225,7 +226,9 @@ for a guideline with more details.

PyPOTS is available on both [PyPI](https://pypi.python.org/pypi/pypots)
and [Anaconda](https://anaconda.org/conda-forge/pypots).
You can install PyPOTS like below as well as TSDB and PyGrinder:
You can install PyPOTS like below as well as
[TSDB](https://github.com/WenjieDu/TSDB),[PyGrinder](https://github.com/WenjieDu/PyGrinder),
[BenchPOTS](https://github.com/WenjieDu/BenchPOTS), and [AI4TS](https://github.com/WenjieDu/AI4TS):

``` bash
# via pip
Expand All @@ -235,8 +238,8 @@ pip install pypots --upgrade # update pypots to the latest version
pip install https://github.com/WenjieDu/PyPOTS/archive/main.zip

# via conda
conda install -c conda-forge pypots # the first time installation
conda update -c conda-forge pypots # update pypots to the latest version
conda install conda-forge::pypots # the first time installation
conda update conda-forge::pypots # update pypots to the latest version
```

## ❖ Usage
Expand Down
Loading
Loading