TerraTorch is a PyTorch domain library based on PyTorch Lightning and the TorchGeo domain library for geospatial data.
TerraTorch provides tools for fine-tuning and using pretrained models. No models are hosted by TerraTorch. TerraTorch only provides the training and inference framework.
User responsibility: It is the sole responsibility of the user to verify that the license of any model they download, fine-tune, or deploy allows their intended use. The TerraTorch maintainers do not provide legal advice and are not liable for any misuse of third-party models.
Watch the latest recording on YouTube: Earth observation foundation models with Prithvi-EO-2.0 and TerraTorch
TerraTorch’s main purpose is to provide a flexible fine-tuning framework for Geospatial Foundation Models, which can be interacted with at different abstraction levels. The library provides:
- Convenient modelling tools:
- Flexible trainers for Image Segmentation, Classification and Pixel Wise Regression fine-tuning tasks
- Model factories that allow to easily combine backbones and decoders for different tasks
- Ready-to-go datasets and datamodules that require only to point to your data with no need of creating new custom classes
- Launching of fine-tuning tasks through CLI and flexible configuration files, or via jupyter notebooks
- Easy access to:
- Open source pre-trained Geospatial Foundation Model backbones:
- Backbones available in the timm (Pytorch image models)
- Decoders available in SMP (Pytorch Segmentation models with pre-training backbones) and mmsegmentation packages
- Fine-tuned models such as granite-geospatial-biomass
- All GEO-Bench datasets and datamodules
- All TorchGeo datasets and datamodules
In order to use the file pyproject.toml it is necessary to guarantee pip>=21.8. If necessary upgrade pip using python -m pip install --upgrade pip.
For a stable point-release, use pip install terratorch==<version>.
To get the most recent version of the branch main, install the library with pip install git+https://github.com/IBM/terratorch.git.
TerraTorch is also available on conda-forge, to install from there do conda install -c conda-forge terratorch.
Alternatively, it is possible to install using pipx via pipx install terratorch, which creates an isolated environment and allows the user to run the application as a common CLI tool, with no need of installing dependencies or activating environments.
TerraTorch requires gdal to be installed, which can be quite a complex process.
If you don't have GDAL set up on your system, we recommend using a conda
environment and installing it with conda install -c conda-forge gdal. If you
are installing from conda-forge it probably won't be a problem.
To install as a developer (e.g. to extend the library):
git clone https://github.com/IBM/terratorch.git
cd terratorch
pip install -r requirements_test.txt
conda install -c conda-forge gdal
pip install -e .
To install terratorch with partial (work in development) support for Weather Foundation Models, pip install -e .[wxc], which currently works just for Python >= 3.11.
To get started, check out the quick start guide.
Developers, check out the architecture overview.
TerraTorch: The Geospatial Foundation Models Toolkit on arXiv
This project welcomes contributions and suggestions. Ways to contribute or get involved:
- Join our Slack
- Create an Issue (for bugs or feature requests)
- Contribute via PR
- Join our duoweekly community calls taking place Tuesdays 4:30 PM - 5 PM CEST and Thursdays 2:30 PM - 3 PM CEST.
You can find more detailed contribution guidelines here.
A simple hint for any contributor. If you want to meet the GitHub DCO checks, just do your commits as below:
git commit -s -m <message>
It will sign the commit with your ID and the check will be met.
TerraTorch is supported by the EU’s Horizon Europe program under Grant Agreement number 101131841 and also received funding from the Swiss State Secretariat for Education, Research and Innovation (SERI) and the UK Research and Innovation (UKRI).
This project is primarily licensed under the Apache License 2.0.
However, some files contain code licensed under the MIT License. These files are explicitly listed in MIT_FILES.txt.
By contributing to this repository, you agree that your contributions will be licensed under the Apache 2.0 License unless otherwise stated.
For more details, see the LICENSE file.