Metadata-Version: 2.1
Name: pytorchtime
Version: 0.1.2
Summary: A time series package for PyTorch
Author-email: Vincent Scharf <vincent.scharf@smail.inf.h-brs.de>
Project-URL: repository, https://github.com/VincentSch4rf/torchtime
Keywords: python,torchtime
Classifier: Environment :: Plugins
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: torch ==2.4.*
Requires-Dist: pytorch-lightning ==2.4.*
Requires-Dist: requests
Requires-Dist: typing-extensions
Requires-Dist: numpy
Requires-Dist: tqdm
Requires-Dist: pandas
Provides-Extra: test
Requires-Dist: pytest ==7.4.* ; extra == 'test'
Requires-Dist: pytest-mock ==3.10.* ; extra == 'test'

torchtime: time series library for PyTorch
==========================================
[![Downloads](https://static.pepy.tech/badge/pytorchtime)](https://pypi.org/project/pytorchtime)
[![Documentation](https://img.shields.io/badge/dynamic/json.svg?label=docs&url=https%3A%2F%2Fpypi.org%2Fpypi%2Fpytorchtime%2Fjson&query=%24.info.version&colorB=brightgreen&prefix=v)](https://pytorchtime.com/docs/stable)

![Torchtime Logo](https://github.com/VincentSch4rf/torchtime/raw/main/docs/source/_static/img/logo-dark.svg)

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

The aim of torchtime is to apply [PyTorch](https://github.com/pytorch/pytorch) to
the time series domain. By supporting PyTorch, torchtime follows the same philosophy
of providing strong GPU acceleration, having a focus on trainable features through
the autograd system, and having consistent style (tensor names and dimension names).
Therefore, it is primarily a machine learning library and not a general signal
processing library. The benefits of PyTorch can be seen in torchtime through
having all the computations be through PyTorch operations which makes it easy
to use and feel like a natural extension.

- [Support time series I/O (Load files, Save files)](http://pytorchtime.com/docs/stable/)
  - Load a variety of time series formats, such as `ts`, `arff`, `dvi`, `dxd`, into a torch Tensor
- [Dataloaders for common time series datasets](http://pytorchtime.com/docs/stable/datasets.html)
- Common time series transforms
    - [Nan2Value, Normalization, Padding, Resample](http://pytorchtime.com/docs/stable/transforms.html)

Installation
------------

Please refer to https://pytorchtime.com/docs/stable/installation.html for installation and build process of torchtime.

API Reference
-------------

API Reference is located here: http://pytorchtime.com/docs/stable/

Contributing Guidelines
-----------------------

Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md)

Citation
--------

If you find this package useful, please cite as:

```bibtex
@article{scharf2022torchtime,
    title={PyTorch Time: Bringing Deep Learning to Time Series Classification},
    author={Vincent Scharf},
    url={https://github.com/VincentSch4rf/torchtime},
    year={2022}
}
```

Disclaimer on Datasets
----------------------

This is a utility library that downloads and prepares public datasets. We do not host or distribute these datasets, vouch for their quality or fairness, or claim that you have license to use the dataset. It is your responsibility to determine whether you have permission to use the dataset under the dataset's license.

If you're a dataset owner and wish to update any part of it (description, citation, etc.), or do not want your dataset to be included in this library, please get in touch through a GitHub issue. Thanks for your contribution to the ML community!
