Skip to main content

rslearn is a tool for developing remote sensing datasets and models.

rslearn helps with:

  1. Developing remote sensing datasets, starting with defining spatiotemporal windows (3D boxes in height/width/time) that are roughly equivalent to training examples.
  2. Importing raster and vector data from various online or local data sources into the dataset.
  3. Fine-tuning remote sensing foundation models on these datasets.
  4. 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:

  1. First, read CoreConcepts, which summarizes key concepts in rslearn, including datasets, windows, layers, and data sources.
  2. Second, read the Usage overview, which provides an overview of the typical workflow in rslearn, from defining windows to training models.
  3. 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rslearn-0.1.14.tar.gz (477.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rslearn-0.1.14-py3-none-any.whl (596.6 kB view details)

Uploaded Python 3

File details

Details for the file rslearn-0.1.14.tar.gz.

File metadata

  • Download URL: rslearn-0.1.14.tar.gz
  • Upload date:
  • Size: 477.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for rslearn-0.1.14.tar.gz
Algorithm Hash digest
SHA256 3169c7e2d224ffd1c2b7e514d6c5cdf1e64a15b61cc4fd187ee4f766da06bafd
MD5 ddd8d75331ea0b7fefa2a7c3a1aa2eac
BLAKE2b-256 d6ded20028952f87e79270966e44ef9d397835ccd1a5fb947ba4e9dfd53f1e6d

See more details on using hashes here.

Provenance

The following attestation bundles were made for rslearn-0.1.14.tar.gz:

Publisher: publish.yml on allenai/rslearn

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rslearn-0.1.14-py3-none-any.whl.

File metadata

  • Download URL: rslearn-0.1.14-py3-none-any.whl
  • Upload date:
  • Size: 596.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for rslearn-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 78eb1422acda687e2de546d0e3d21d45cf8d336075b930760fc8661b075caa59
MD5 9ea5f8b50df642c1396f5a21e0971693
BLAKE2b-256 8aaf9124ecd690a81aaf28dbcd80db11de2320d03627f4b93bdd04b49f2ba8ab

See more details on using hashes here.

Provenance

The following attestation bundles were made for rslearn-0.1.14-py3-none-any.whl:

Publisher: publish.yml on allenai/rslearn

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.14 This release

2 files

0.1.13

2 files

0.1.12

2 files

0.1.11

2 files

0.1.10

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.29

2 files

0.0.28

2 files

0.0.27

2 files

0.0.26

2 files

0.0.25

2 files

0.0.24

2 files

0.0.23

2 files

0.0.22

2 files

0.0.21

2 files

0.0.20

2 files

0.0.19

2 files

0.0.18

2 files

0.0.17

2 files

0.0.16

2 files

0.0.15

2 files

0.0.14

2 files

0.0.13

2 files

0.0.12

2 files

0.0.11

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page