A PyTorch library for spatiotemporal data processing
Project description
Neural spatiotemporal forecasting with PyTorch
🚀 Getting Started - 📚 Documentation - 💻 Introductory notebook
tsl (Torch Spatiotemporal) is a library built to accelerate research on neural spatiotemporal data processing methods, with a focus on Graph Neural Networks.
tsl is built on several libraries of the Python scientific computing ecosystem, with the final objective of providing a straightforward process that goes from data preprocessing to model prototyping. In particular, tsl offers a wide range of utilities to develop neural networks in PyTorch for processing spatiotemporal data signals.
Getting Started
Before you start using tsl, please review the documentation to get an understanding of the library and its capabilities.
You can also explore the examples provided in the examples
directory to see how train deep learning models working with spatiotemporal data.
Installation
Before installing tsl, make sure you have installed PyTorch (>=1.9.0) and PyG (>=2.0.3) in your virtual environment (see PyG installation guidelines). tsl is available for Python>=3.8. We recommend installation from github to be up-to-date with the latest version:
pip install git+https://github.com/TorchSpatiotemporal/tsl.git
Alternatively, you can install the library from the pypi repository:
pip install torch-spatiotemporal
To avoid dependencies issues, we recommend using Anaconda and the provided environment configuration by running the command:
conda env create -f conda_env.yml
Tutorial
The best way to start using tsl is by following the tutorial notebook in examples/notebooks/a_gentle_introduction_to_tsl.ipynb
.
Documentation
The documentation is hosted on readthedocs. For local access, you can build it from the docs
directory.
Citing
If you use Torch Spatiotemporal for your research, please consider citing the library
@software{Cini_Torch_Spatiotemporal_2022,
author = {Cini, Andrea and Marisca, Ivan},
license = {MIT},
month = {3},
title = {{Torch Spatiotemporal}},
url = {https://github.com/TorchSpatiotemporal/tsl},
year = {2022}
}
By Andrea Cini and Ivan Marisca.
Thanks to all contributors! Check the Contributing guidelines and help us build a better tsl.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for torch_spatiotemporal-0.9.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdf31e38d37dc6fc993543c642260871c98a06fa4912eeca4e7e47a6e9cc40d0 |
|
MD5 | a5c09ce603c731ba037d8b2e2ba2646a |
|
BLAKE2b-256 | 356c58757c324edd0976391463abd3630c8364b8f2e1a5061f594f189564a7ab |
Hashes for torch_spatiotemporal-0.9.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83a43968efe5fbd851d3ff133e4fd6c9f979a1e2a9f68984794f095bbe2dbfc4 |
|
MD5 | 6b6db8b1b3976336bfbccb62fdfc85d8 |
|
BLAKE2b-256 | dbde16a81fbdbb7f150e46e9e1d45afc78415ede816c13076630e3d99aba2be8 |