| Name | torch-timeseries JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | https://github.com/wayne155/pytorch_timeseries |
| Summary | Timeseries Learning Library for PyTorch. |
| upload_time | 2024-06-24 07:50:42 |
| maintainer | None |
| docs_url | None |
| author | Weiwei Ye |
| requires_python | >=3.8 |
| license | Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. |
| keywords |
deep learning
time series
pytorch
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[pypi-image]: https://badge.fury.io/py/torch-timeseries.svg
[pypi-url]: https://pypi.python.org/pypi/torch-timeseries
[docs-image]: https://readthedocs.org/projects/pytorch-timeseries/badge/?version=latest
[docs-url]: https://pytorch-timeseries.readthedocs.io/en/latest/?badge=latest
<p align="center">
<img width="90%" src="https://raw.githubusercontent.com/wayne155/pytorch_timeseries/main/docs/_static/img/logo_text.jpg?sanitize=true" />
</p>
[![PyPI Version][pypi-image]][pypi-url]
[![Docs Status][docs-image]][docs-url]
# pytorch_timeseries
An all in one deep learning library that boost your timeseries research.
[Check the documentation for more detail](https://pytorch-timeseries.readthedocs.io/en/latest/).
Compared to previous libraries, pytorch_timeseries is
- dataset automatically downloaded
- easy to use and extend
- clear documentation
- highly customizable
- install and run!
- ..........
## 1. installation
```
pip install torch-timeseries
```
> ⚠️⚠️⚠️ **Warning: We only support python version >= 3.8+**
## 2. Running Implemented Experiments
### Forecast
```python
# running DLinear Forecast on dataset ETTh1 with seed = 3
pytexp --model DLinear --task Forecast --dataset_type ETTh1 run 3
# running DLinear Forecast on dataset ETTh1 with seeds=[1,2,3]
pytexp --model DLinear --task Forecast --dataset_type ETTh1 runs '[1,2,3]'
```
### Imputation
```python
# running DLinear Imputation on dataset ETTh1 with seed = 3
pytexp --model DLinear --task Imputation --dataset_type ETTh1 run 3
# running DLinear Imputation on dataset ETTh1 with seed = [1,2,3]
pytexp --model DLinear --task Imputation --dataset_type ETTh1 runs '[1,2,3]'
```
### UEAClassification
```python
# running DLinear UEAClassification on dataset EthanolConcentration with seed = 3
pytexp --model DLinear --task UEAClassification --dataset_type EthanolConcentration run 3
# running DLinear UEAClassification on dataset EthanolConcentration with seed = [1,2,3]
pytexp --model DLinear --task UEAClassification --dataset_type EthanolConcentration runs '[1,2,3]'
```
### AnomalyDetection
```python
# running DLinear AnomalyDetection on dataset MSL with seed = [1,2,3]
pytexp --model DLinear --task AnomalyDetection --dataset_type MSL run 3
# running DLinear AnomalyDetection on dataset MSL with seed = [1,2,3]
pytexp --model DLinear --task AnomalyDetection --dataset_type MSL runs 3
```
# Development Milestones
## Implemented Datasets
Full list of datasets can be found at [Documentation](https://pytorch-timeseries.readthedocs.io/en/latest/modules/dataset.html).
| Datasets | Forecasting | Imputation | Anomaly | Classification|
| --------- | ------- | ------- | ------- | ------- |
| [ETTh1](https://ojs.aaai.org/index.php/AAAI/article/view/17325) | ✅ |✅ | | |
| [ETTh2](https://ojs.aaai.org/index.php/AAAI/article/view/17325) | ✅ |✅ | | |
| [ETTm1](https://ojs.aaai.org/index.php/AAAI/article/view/17325) | ✅ |✅ | | |
| [ETTm2](https://ojs.aaai.org/index.php/AAAI/article/view/17325) | ✅ |✅ | | |
| [......And More](https://pytorch-timeseries.readthedocs.io/en/latest/modules/dataset.html) | ✅ |✅ | ✅ | ✅ |
## Implemented Tasks
- [x] Forecast
- [x] Classfication (for UEA datasets)
- [x] Anomaly Detection
- [x] Imputation
- [ ] You can fill this check box! (contribute to develop your own task!)
## Implemented Models
| Models | Forecasting | Imputation | Anomaly | Classification|
| --------- | ------- | ------- | ------- | ------- |
| [Informer (2021)](https://ojs.aaai.org/index.php/AAAI/article/view/17325) | ✅ |✅ |✅ |✅ |
| [Autoformer (2021)](https://proceedings.neurips.cc/paper/2021/hash/bcc0d400288793e8bdcd7c19a8ac0c2b-Abstract.html) | ✅ |✅ |✅ |✅ |
| [FEDformer (2022)](https://proceedings.mlr.press/v162/zhou22g.html) | ✅ |✅ |✅ |✅ |
| [DLinear (2022)](https://ojs.aaai.org/index.php/AAAI/article/view/26317) | ✅ |✅ |✅ |✅ |
| [PatchTST (2022)](https://openreview.net/forum?id=Jbdc0vTOcol&trk=public_post_comment-text) | ✅ |✅ |✅ |✅ |
| [iTransformer (2024)](https://openreview.net/forum?id=JePfAI8fah) | ✅ |✅ |✅ |✅ |
<!-- ## Implemented Datasets
Currently we have implemented all popular datasets, including
| Datasets | Forecasting | Imputation | Anomaly | Classification|
| --------- | ------- | ------- | ------- | ------- |
| [ETTh1](https://ojs.aaai.org/index.php/AAAI/article/view/26317) | ✅ |✅ | | |
| [ETTh2](https://ojs.aaai.org/index.php/AAAI/article/view/26317) | ✅ |✅ | | |
| [ETTm1](https://ojs.aaai.org/index.php/AAAI/article/view/26317) | ✅ |✅ | | |
| [ETTm2](https://ojs.aaai.org/index.php/AAAI/article/view/26317) | ✅ |✅ | | |
[Check the documentation for more detail](https://pytorch-timeseries.readthedocs.io/en/latest/).
-->
# Customizing Your Own Pipeline
we provide examples of :
- [forecast](https://github.com/wayne155/pytorch_timeseries/blob/main/examples/forecast.py)
- [imputation](https://github.com/wayne155/pytorch_timeseries/blob/main/examples/mask.py)
- [anomaly detection](https://github.com/wayne155/pytorch_timeseries/blob/main/examples/anomaly.py)
- [UEA classfication](https://github.com/wayne155/pytorch_timeseries/blob/main/examples/ueaclass.py)
Detail of customize forecasting pipeline is as follows:
## 1 Forecasting
### 1.1 download dataset
The dataset will be downloaded **automatically!!!!**
```python
from torch_timeseries.dataset import ETTh1
from torch_timeseries.dataloader import StandardScaler, SlidingWindow, SlidingWindowTS
from torch_timeseries.model import DLinear
from torch.nn import MSELoss, L1Loss
from torch.optim import Adam
dataset = ETTh1('./data')
```
### 1.2 setup scaler/dataloader
Once you setup a dataloader and pass a scaler into this dataloader, the scaler will be fitted on the training set.
```python
scaler = StandardScaler()
dataloader = SlidingWindowTS(dataset,
window=96,
horizon=1,
steps=336,
batch_size=32,
train_ratio=0.7,
val_ratio=0.2,
scaler=scaler,
)
```
After this, you can access the train/val/test loader by `dataloader.train_loader/val_loader/test_loader`
### 1.3 training
```python
model = DLinear(dataloader.window, dataloader.steps, dataset.num_features, individual= True)
optimizer = Adam(model.parameters())
loss_function = MSELoss()
# train
model.train()
for scaled_x, scaled_y, x, y, x_date_enc, y_date_enc in dataloader.train_loader:
optimizer.zero_grad()
scaled_x = scaled_x.float()
scaled_y = scaled_y.float()
scaled_pred_y = model(scaled_x)
loss = loss_function(scaled_pred_y, scaled_y)
loss.backward()
optimizer.step()
print(loss)
```
### 1.4 val/test
```python
# val
model.eval()
for scaled_x, scaled_y, x, y, x_date_enc, y_date_enc in dataloader.val_loader:
....your validation code here...
# test
model.eval()
for scaled_x, scaled_y, x, y, x_date_enc, y_date_enc in dataloader.test_loader:
....your test code here...
```
# Dev Install
## install requirements
> Note:This library assumes that you've installed Pytorch according to it's official website, the basic dependencies of torch > > related libraries may not be listed in the requirements files:
https://pytorch.org/get-started/locally/
**The recommended python version is 3.8.1+.**
1. fork this project
2. clone this project (latest version)
```
git clone https://github.com/wayne155/pytorch_timeseries
```
3. install requirements.
```
pip install -r ./requirements.txt
```
4. change some code and push to the forked repo
5. create a pull request to this repo
Raw data
{
"_id": null,
"home_page": "https://github.com/wayne155/pytorch_timeseries",
"name": "torch-timeseries",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "deep Learning, time series, pytorch",
"author": "Weiwei Ye",
"author_email": "Wayne Yip <wwye155@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/12/a2/8efe5d1a5bca0f751e0887faaa52fcd7310d6f4caff542921120247a262a/torch_timeseries-0.1.3.tar.gz",
"platform": null,
"description": "[pypi-image]: https://badge.fury.io/py/torch-timeseries.svg\n[pypi-url]: https://pypi.python.org/pypi/torch-timeseries\n[docs-image]: https://readthedocs.org/projects/pytorch-timeseries/badge/?version=latest\n[docs-url]: https://pytorch-timeseries.readthedocs.io/en/latest/?badge=latest\n\n\n\n<p align=\"center\">\n <img width=\"90%\" src=\"https://raw.githubusercontent.com/wayne155/pytorch_timeseries/main/docs/_static/img/logo_text.jpg?sanitize=true\" />\n</p>\n\n[![PyPI Version][pypi-image]][pypi-url]\n[![Docs Status][docs-image]][docs-url]\n\n\n\n# pytorch_timeseries\nAn all in one deep learning library that boost your timeseries research.\n[Check the documentation for more detail](https://pytorch-timeseries.readthedocs.io/en/latest/).\n\n\n\nCompared to previous libraries, pytorch_timeseries is \n- dataset automatically downloaded\n- easy to use and extend \n- clear documentation \n- highly customizable \n- install and run! \n- ..........\n\n\n\n## 1. installation\n\n\n\n```\npip install torch-timeseries\n```\n\n> \u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f **Warning: We only support python version >= 3.8+**\n\n\n## 2. Running Implemented Experiments\n\n### Forecast\n```python\n# running DLinear Forecast on dataset ETTh1 with seed = 3 \npytexp --model DLinear --task Forecast --dataset_type ETTh1 run 3\n# running DLinear Forecast on dataset ETTh1 with seeds=[1,2,3]\npytexp --model DLinear --task Forecast --dataset_type ETTh1 runs '[1,2,3]'\n```\n\n\n### Imputation\n```python\n# running DLinear Imputation on dataset ETTh1 with seed = 3 \npytexp --model DLinear --task Imputation --dataset_type ETTh1 run 3\n# running DLinear Imputation on dataset ETTh1 with seed = [1,2,3] \npytexp --model DLinear --task Imputation --dataset_type ETTh1 runs '[1,2,3]'\n```\n### UEAClassification\n```python\n# running DLinear UEAClassification on dataset EthanolConcentration with seed = 3 \npytexp --model DLinear --task UEAClassification --dataset_type EthanolConcentration run 3\n# running DLinear UEAClassification on dataset EthanolConcentration with seed = [1,2,3] \npytexp --model DLinear --task UEAClassification --dataset_type EthanolConcentration runs '[1,2,3]'\n```\n\n### AnomalyDetection\n```python\n# running DLinear AnomalyDetection on dataset MSL with seed = [1,2,3] \npytexp --model DLinear --task AnomalyDetection --dataset_type MSL run 3\n# running DLinear AnomalyDetection on dataset MSL with seed = [1,2,3] \npytexp --model DLinear --task AnomalyDetection --dataset_type MSL runs 3\n```\n\n\n# Development Milestones\n## Implemented Datasets\nFull list of datasets can be found at [Documentation](https://pytorch-timeseries.readthedocs.io/en/latest/modules/dataset.html).\n| Datasets | Forecasting | Imputation | Anomaly | Classification|\n| --------- | ------- | ------- | ------- | ------- |\n| [ETTh1](https://ojs.aaai.org/index.php/AAAI/article/view/17325) | \u2705 |\u2705 | | |\n| [ETTh2](https://ojs.aaai.org/index.php/AAAI/article/view/17325) | \u2705 |\u2705 | | |\n| [ETTm1](https://ojs.aaai.org/index.php/AAAI/article/view/17325) | \u2705 |\u2705 | | |\n| [ETTm2](https://ojs.aaai.org/index.php/AAAI/article/view/17325) | \u2705 |\u2705 | | |\n| [......And More](https://pytorch-timeseries.readthedocs.io/en/latest/modules/dataset.html) | \u2705 |\u2705 | \u2705 | \u2705 |\n\n## Implemented Tasks\n\n- [x] Forecast\n- [x] Classfication (for UEA datasets)\n- [x] Anomaly Detection \n- [x] Imputation\n- [ ] You can fill this check box! (contribute to develop your own task!)\n\n## Implemented Models\n\n| Models | Forecasting | Imputation | Anomaly | Classification|\n| --------- | ------- | ------- | ------- | ------- |\n| [Informer (2021)](https://ojs.aaai.org/index.php/AAAI/article/view/17325) | \u2705 |\u2705 |\u2705 |\u2705 |\n| [Autoformer (2021)](https://proceedings.neurips.cc/paper/2021/hash/bcc0d400288793e8bdcd7c19a8ac0c2b-Abstract.html) | \u2705 |\u2705 |\u2705 |\u2705 |\n| [FEDformer (2022)](https://proceedings.mlr.press/v162/zhou22g.html) | \u2705 |\u2705 |\u2705 |\u2705 |\n| [DLinear (2022)](https://ojs.aaai.org/index.php/AAAI/article/view/26317) | \u2705 |\u2705 |\u2705 |\u2705 |\n| [PatchTST (2022)](https://openreview.net/forum?id=Jbdc0vTOcol&trk=public_post_comment-text) | \u2705 |\u2705 |\u2705 |\u2705 |\n| [iTransformer (2024)](https://openreview.net/forum?id=JePfAI8fah) | \u2705 |\u2705 |\u2705 |\u2705 |\n\n<!-- ## Implemented Datasets\nCurrently we have implemented all popular datasets, including\n\n| Datasets | Forecasting | Imputation | Anomaly | Classification|\n| --------- | ------- | ------- | ------- | ------- |\n| [ETTh1](https://ojs.aaai.org/index.php/AAAI/article/view/26317) | \u2705 |\u2705 | | |\n| [ETTh2](https://ojs.aaai.org/index.php/AAAI/article/view/26317) | \u2705 |\u2705 | | |\n| [ETTm1](https://ojs.aaai.org/index.php/AAAI/article/view/26317) | \u2705 |\u2705 | | |\n| [ETTm2](https://ojs.aaai.org/index.php/AAAI/article/view/26317) | \u2705 |\u2705 | | |\n\n[Check the documentation for more detail](https://pytorch-timeseries.readthedocs.io/en/latest/).\n -->\n\n# Customizing Your Own Pipeline\n\nwe provide examples of :\n- [forecast](https://github.com/wayne155/pytorch_timeseries/blob/main/examples/forecast.py)\n- [imputation](https://github.com/wayne155/pytorch_timeseries/blob/main/examples/mask.py)\n- [anomaly detection](https://github.com/wayne155/pytorch_timeseries/blob/main/examples/anomaly.py)\n- [UEA classfication](https://github.com/wayne155/pytorch_timeseries/blob/main/examples/ueaclass.py)\n\nDetail of customize forecasting pipeline is as follows:\n\n## 1 Forecasting\n\n### 1.1 download dataset\nThe dataset will be downloaded **automatically!!!!**\n```python\nfrom torch_timeseries.dataset import ETTh1\nfrom torch_timeseries.dataloader import StandardScaler, SlidingWindow, SlidingWindowTS\nfrom torch_timeseries.model import DLinear\nfrom torch.nn import MSELoss, L1Loss\nfrom torch.optim import Adam\ndataset = ETTh1('./data')\n```\n\n### 1.2 setup scaler/dataloader\n\nOnce you setup a dataloader and pass a scaler into this dataloader, the scaler will be fitted on the training set.\n\n\n```python\nscaler = StandardScaler()\ndataloader = SlidingWindowTS(dataset, \n window=96,\n horizon=1,\n steps=336,\n batch_size=32, \n train_ratio=0.7, \n val_ratio=0.2, \n scaler=scaler,\n )\n\n```\nAfter this, you can access the train/val/test loader by `dataloader.train_loader/val_loader/test_loader` \n\n### 1.3 training\n\n\n\n```python\nmodel = DLinear(dataloader.window, dataloader.steps, dataset.num_features, individual= True)\noptimizer = Adam(model.parameters())\nloss_function = MSELoss()\n\n# train\nmodel.train()\nfor scaled_x, scaled_y, x, y, x_date_enc, y_date_enc in dataloader.train_loader:\n optimizer.zero_grad()\n \n scaled_x = scaled_x.float()\n scaled_y = scaled_y.float()\n scaled_pred_y = model(scaled_x) \n \n loss = loss_function(scaled_pred_y, scaled_y)\n loss.backward()\n optimizer.step()\n print(loss)\n```\n\n### 1.4 val/test\n\n```python\n# val\nmodel.eval()\nfor scaled_x, scaled_y, x, y, x_date_enc, y_date_enc in dataloader.val_loader:\n ....your validation code here...\n\n# test\nmodel.eval()\nfor scaled_x, scaled_y, x, y, x_date_enc, y_date_enc in dataloader.test_loader:\n ....your test code here...\n```\n\n\n# Dev Install \n\n## install requirements\n> Note:This library assumes that you've installed Pytorch according to it's official website, the basic dependencies of torch > > related libraries may not be listed in the requirements files:\nhttps://pytorch.org/get-started/locally/\n\n**The recommended python version is 3.8.1+.**\n1. fork this project \n\n2. clone this project (latest version)\n```\ngit clone https://github.com/wayne155/pytorch_timeseries\n```\n\n3. install requirements.\n```\npip install -r ./requirements.txt\n```\n\n4. change some code and push to the forked repo\n\n5. create a pull request to this repo\n",
"bugtrack_url": null,
"license": "Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License. \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\" \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ",
"summary": "Timeseries Learning Library for PyTorch.",
"version": "0.1.3",
"project_urls": {
"BugTracker": "https://github.com/wayne155/pytorch_timeseries/issues",
"Documentation": "https://pytorch-timeseries.readthedocs.io",
"Download": "https://github.com/wayne155/pytorch_timeseries/archive/0.1.3.tar.gz",
"Homepage": "https://github.com/wayne155/pytorch_timeseries"
},
"split_keywords": [
"deep learning",
" time series",
" pytorch"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1cd8d2b6ebefcca60dd1f77edd6e26906d0a02573d6c721888209b73af8409bd",
"md5": "a47f49da119b9028f10f91e02af65da3",
"sha256": "0e2f85ebb0c15d0a21db307f1601588d996304b1b1ee03badd1ae8b47fd592e1"
},
"downloads": -1,
"filename": "torch_timeseries-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a47f49da119b9028f10f91e02af65da3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 114505,
"upload_time": "2024-06-24T07:50:34",
"upload_time_iso_8601": "2024-06-24T07:50:34.949596Z",
"url": "https://files.pythonhosted.org/packages/1c/d8/d2b6ebefcca60dd1f77edd6e26906d0a02573d6c721888209b73af8409bd/torch_timeseries-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "12a28efe5d1a5bca0f751e0887faaa52fcd7310d6f4caff542921120247a262a",
"md5": "4c36ed4506aaec9428335e9ed945f11f",
"sha256": "5d974b35e0e405d49fdbf2dce4cfd9678528732ac65c045dc17cfdca96c999fc"
},
"downloads": -1,
"filename": "torch_timeseries-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "4c36ed4506aaec9428335e9ed945f11f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 69922,
"upload_time": "2024-06-24T07:50:42",
"upload_time_iso_8601": "2024-06-24T07:50:42.774845Z",
"url": "https://files.pythonhosted.org/packages/12/a2/8efe5d1a5bca0f751e0887faaa52fcd7310d6f4caff542921120247a262a/torch_timeseries-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-24 07:50:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wayne155",
"github_project": "pytorch_timeseries",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "torch-timeseries"
}
