GEOT: A spatially explicit framework for evaluating spatio-temporal predictions
This repo contains code to evaluate spatiotemporal predictions with Optimal Transport (OT). In contrast to standard evaluation metrics (MSE, MAE etc), the OT error is a spatial metric that evaluates the spatial distribution of the errors.
Install
First, install a suitable torch version. Then, install the package via pypi:
pip install geot
Or from source:
git clone https://github.com/mie-lab/geospatialOT.git
cd geospatialOT
conda create -n geot_env
conda activate geot_env
pip install .
Explanation of usage:
- Assume we want to predict some observations in several locations, e.g., bike sharing demand at bike sharing stations, over time
- Usually, the error is just averaged over locations (MSE between GT and prediction)
- However, in real-world applications, there are distance-based costs involved with prediction errors. For example, prediction errors cause costs for relocating bikes
- Assue we can define a cost matrix with the pairwise costs between locations, indicating the cost to account for errors
- With Optimal Transport, we can compute the minimum costs for transforming the predictions to the ground truth - a better indicator for the real-world costs of prediction errors than just the MSE
With this code, you can compute the OT error for your predictions. The input is usually just the observations at a set of location, the predictions and the cost matrix. The output is the OT error (a single number) or the optimal transport matrix T.
Tutorial
Check out our tutorial to get started with a simple example.
Metadata
Release files for geot 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| geot-0.1.0.tar.gz | 11.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| geot-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 23.5 kB
Release files / geot-0.1.0.tar.gz
| Download URL | geot-0.1.0.tar.gz |
|---|---|
| Size | 11.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
220577ef3581d6c1012211ff7f28a85f1227a0190f01c8be6ce3cc4f15299a8f
|
|
BLAKE2b-256 checksum How to use checksums |
7a2653994c4f65b765e6d027ffcebf674f9906055d1437476bffa1a6e5037a1b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.9.18
|
Release files / geot-0.1.0-py3-none-any.whl
| Download URL | geot-0.1.0-py3-none-any.whl |
|---|---|
| Size | 11.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fdbcfcc06fd303af88645f0b9812f3d70dc04c14266a17c95f247ec034c745e9
|
|
BLAKE2b-256 checksum How to use checksums |
69eea7a82bcaee3795c84dcd40dd2166ed456ac47ab29156f67aaec52aa7d2b2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.9.18
|
Security for geot 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.