rslearn is a tool for developing remote sensing datasets and models.
rslearn helps with:
- Developing remote sensing datasets, starting with defining spatiotemporal windows (3D boxes in height/width/time) that are roughly equivalent to training examples.
- Importing raster and vector data from various online or local data sources into the dataset.
- Fine-tuning remote sensing foundation models on these datasets.
- Applying models on new locations and times.
Full documentation is available at https://allenai.github.io/rslearn/.
Quickstart
If you are new to rslearn, we suggest starting here:
- First, read CoreConcepts, which summarizes key concepts in rslearn, including datasets, windows, layers, and data sources.
- Second, read the Usage overview, which provides an overview of the typical workflow in rslearn, from defining windows to training models.
- Finally, walk through the Quickstart, or find another example in Examples.md that can most readily be adapted for your project.
Other links:
- DatasetConfig documents the dataset configuration file.
- DataSources details the built-in data sources in rslearn, from which raster and vector data can be imported into rslearn dataset layers.
- Compositors documents built-in and custom raster compositing methods, including cloud-aware ranking compositors.
- ModelConfig documents the model configuration file.
- TasksAndModels details the training tasks and model components available in rslearn.
Setup
rslearn requires Python 3.11+ (Python 3.12 is recommended).
git clone https://github.com/allenai/rslearn.git
cd rslearn
pip install .[extra]
For linting and tests:
pip install .[dev]
pre-commit install
pre-commit run --all-files
pytest tests/unit tests/integration
# For online data source tests, you can store credentials in .env and they will be
# loaded by pytest-dotenv.
pytest tests/online
Contact
For questions and suggestions, please open an issue on GitHub.
Release files for rslearn 0.1.16
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rslearn-0.1.16.tar.gz | 488.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rslearn-0.1.16-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.1 MB
Release files / rslearn-0.1.16.tar.gz
| Download URL | rslearn-0.1.16.tar.gz |
|---|---|
| Size | 488.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
02c9cfd25e911c2433894af03e08395fa0aae4b06f225a576a66501d46606653
|
|
BLAKE2b-256 checksum How to use checksums |
f08994ca11c0909f536b8ce9af27786733e00adeaba749293f92fe7ee7c0640f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 24, 2026.
Transparency logRelease files / rslearn-0.1.16-py3-none-any.whl
| Download URL | rslearn-0.1.16-py3-none-any.whl |
|---|---|
| Size | 609.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8488e584b39e6c9de7058f8f2c9b20e0a33ae2559488f2b74ee07dd3316eabc3
|
|
BLAKE2b-256 checksum How to use checksums |
21be43392e7ecb5ae1257cbb95f2a9b398d7a85de37a7d7b87c72eef04bc3bba
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 24, 2026.
Transparency log
