Pypots

Here are updates,

1. for missing values after LOCF imputation (that are missing since the first step hence LOCF doesn't work), we added more options to handle them. Please refer to the argument `first_step_imputation` in [LOCF docs](https://docs.pypots.com/en/latest/pypots.imputation.html#module-pypots.imputation.locf). The default option is "zero" in previous versions, but we've changed it to "backward" which is more reasonable;
2. enabled SAITS to return latent attention weights from blocks in predict() for advanced analysis e.g. in 178;
3. renamed model saving and loading functions save_model() and load_model() into save() and load();


What's Changed
* Check if X_intact contains missing data for imputation models, check and list mismatched hyperparameters in the tuning mode by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/234
* Make SAITS return attention weights in predict() by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/239
* Adding other options for the first step imputation in LOCF by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/240
* Fixing the problem about staling issues by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/244
* Testing with Python 3.11 and support it by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/246
* Rename save_model() and load_model() into save() and load() by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/247
* Refactoring save_model() and load_model(), and updating docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/249


**Full Changelog**: https://github.com/WenjieDu/PyPOTS/compare/v0.2...v0.2.1

In PyPOTS v0.2 this new version, we

1. enabled hyperparameter tuning for all NN algorithms;
2. fixed a bug in the updating strategy of term `F` in CRLI;
3. replaced the license GPL-v3 with BSD-3-Clause that has less constraints;
4. announced [PyPOTS ecosystem](https://pypots.com/ecosystem/);


What's Changed
* Adding tsdb and pygrinder into the docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/212
* Fixing disappeared TSDB and PyGrinder by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/213
* Replacing PyCorruptor with PyGrinder by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/215
* Merge the docs of PyPOTS ecosystem, and replace pycorruptor with pygrinder in pypots by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/216
* Clone TSDB and PyGrinder repos to use their latest code and docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/217
* Install from source code to use the latest docs of TSDB and PyGrinder by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/219
* Install from TSDB and PyGrinder repos to use their latest docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/220
* Enable hyperparameter tuning with NNI framework by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/221
* Fixing dependency error in testing_CI workflow by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/223
* Enable hyperparameter tuning with NNI, fix dependency error in testing_CI, and update docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/224
* Fix the bug in the updating strategy of term `F` in CRLI by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/226
* Apply BSD-3 license, and update docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/228
* Fix a bug in CRLI, switch to BSD-3 license by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/229
* Update version limitations on dependencies, and install dependencies in PyPI publishing workflow by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/230


**Full Changelog**: https://github.com/WenjieDu/PyPOTS/compare/v0.1.4...v0.2

In this new version, we made the following changes:

1. added the imputation model CSDI;
2. added the unified method `predict()` for all models to run inference on the given test set;
3. enabled clustering algorithms to select the best model on the validation set;
4. fixed the bug that GP-VAE failed to run on CUDA devices;
5. made SAITS to use customized loss function specified by users;

What's Changed
* Add the method predict() for all models by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/199
* Refactor algorithms' module structure, enable customized loss function in SAITS, enable GP-VAE to run on CUDA, etc. by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/201
* Merge dev into main by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/202
* Make clustering algorithms to select the best model according to the loss on a given validation set by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/204
* Fixing failed CI testing due to dependency installation error by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/206
* Adding the model CSDI by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/208
* Refactoring, and updating the docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/209
* Adding CSDI, updating the docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/210


**Full Changelog**: https://github.com/WenjieDu/PyPOTS/compare/v0.1.3...v0.1.4

In this release, we mainly
1. added new models US-GAN and GP-VAE for the imputation task on POTS data;
2. appended util functions `save_dict_into_h5()` to help users directly save a dataset from a Python Dictionary into an HDF5 file that can be used by models in PyPOTS with lazy-loading strategy to save RAM and CUDA memory;
3. added internal clustering validation measures to help evaluate clustering models;
4. enabled PyPOTS clustering models to return their latent representation for advanced analysis, e.g. internal clustering validation;
5. added learning-rate schedulers for optimizers;

**👍 Kudos to our new contributors, AugustJW and vemuribv! The above points 1 and 3 are implemented by them that enrich this release and make it happen here.**

😎 More awesome features are on the road. Stay tuned or [join us to make them happen](https://join.slack.com/t/pypots-org/shared_invite/zt-1gq6ufwsi-p0OZdW~e9UW_IA4_f1OfxA)!

What's Changed
* Adding the package to store frequently-used modules; by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/170
* feat: add Transformer encoder, decoder, and decoder_layer; by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/172
* Adding the package `pypots/modules`, and appending modules of vanilla Transformer by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/173
* Add internal clustering validation measures to pypots.utils.metrics by vemuribv in https://github.com/WenjieDu/PyPOTS/pull/179
* Add save_dict_into_h5() and sliding_window(), add `.gitignore`, and update the docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/180
* Merge `dev` into `pr/176` by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/181
* Fixing failed doc build by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/186
* Fixing the failed workflow `Autoreply to Issues Opened for PyPOTS` and update the PR template by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/184
* Merge dev into main by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/188
* add models GP-VAE/USGAN by AugustJW in https://github.com/WenjieDu/PyPOTS/pull/176
* Refactor testing cases by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/189
* Add models US-GAN and GP-VAE, update docs, refactor testing cases, add cal_internal_cluster_validation_metrics() by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/190
* Extract latent from clustering models by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/192
* Add internal and external cluster validation funcs, and enable CRLI and VaDER to return latent for advanced analysis by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/193
* Add learning-rate schedulers by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/195
* Add learning-rate schedulers for optimizers, and by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/196
* Releasing v0.1.3; by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/197

New Contributors
* vemuribv made their first contribution in https://github.com/WenjieDu/PyPOTS/pull/179
* AugustJW made their first contribution in https://github.com/WenjieDu/PyPOTS/pull/176

**Full Changelog**: https://github.com/WenjieDu/PyPOTS/compare/v0.1.2...v0.1.3

In this new version, we mainly fix some bugs, update the docs, and update TSDB changed APIs to keep compatible with it.

What's Changed
* Update logging, and fix the error in the usage example by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/131
* Fix single-item device list throwing an error by MaciejSkrabski in https://github.com/WenjieDu/PyPOTS/pull/133
* Fix the single-item device list error, update docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/134
* Specifying the version of protobuf<=4.21.12 to fix issue 135 by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/136
* Update docs and citation info by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/140
* Fix daily testing by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/143
* Fixing failed daily testing with MacOS python 3.7, and update docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/144
* Update docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/148
* Fixing the bug in raindrop when running on multiple devices by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/149
* Updating docs, and fixing the bug in raindrop when running on multiple devices by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/150
* Fixing the invalid badge of PyPI downloads by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/152
* Updating stale workflow, and updating docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/154
* Update actions/stalev8, and fix docs typo by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/156
* fix: the type hint for function `mcar()` in comments by yhzhu99 in https://github.com/WenjieDu/PyPOTS/pull/157
* Update the greeting workflow, and update the docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/159
* Updating workflows and docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/162
* Fixing the bug caused by changed tsdb api, updating the docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/166
* Updating docs and releasing v0.1.2 by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/167

New Contributors
* yhzhu99 made their first contribution in https://github.com/WenjieDu/PyPOTS/pull/157

**Full Changelog**: https://github.com/WenjieDu/PyPOTS/compare/v0.1.1...v0.1.2

In this new version, we

1. enable PyPOTS to run on multiple CUDA devices to train models in parallel. NOW you can further speed up your model training in PyPOTS 🥳;
2. add the imputation model M-RNN;
3. add the optimizer Adadelta;


What's Changed
* Use relative imports replace absolute ones by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/117
* Add optimizer Adadelta, and fix issue 116 by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/118
* Docs auto param type hints by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/119
* Use sphinx_autodoc_typehints to auto gene type hints for params, and improve docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/120
* Enable parallel training on multi GPUs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/122
* skip multi-gpu test if not multi-gpu host by MaciejSkrabski in https://github.com/WenjieDu/PyPOTS/pull/124
* Enable models to run on multiple CUDA devices by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/125
* Add model MRNN by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/126
* Add model M-RNN, and update the docs by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/127
* Fix VaDER failed testing and MRNN failed training on multiple devices by WenjieDu in https://github.com/WenjieDu/PyPOTS/pull/128


**Full Changelog**: https://github.com/WenjieDu/PyPOTS/compare/v0.1.0...v0.1.1