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 WorkflowOverview, 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.13.tar.gz (466.9 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.13-py3-none-any.whl (583.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rslearn-0.1.13.tar.gz
Algorithm Hash digest
SHA256 25c2eb723ccf8a42f2eb493296c0daad79d02ff254d255d2b836563b782d6ef5
MD5 354251732fff084fd6b8cfb9a793c354
BLAKE2b-256 e21e9e73097a46b5a38f7639da5bb4e29e10754d38eb7323cf0bd722d18562ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for rslearn-0.1.13.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.13-py3-none-any.whl.

File metadata

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

File hashes

Hashes for rslearn-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 d9673445a2bf8473abb14ab9386c0153774ce5a124abf7117df4b728d8036130
MD5 c219be17614d5963757f3788312a46c1
BLAKE2b-256 a5e9ee91950fb14ff5f4a4190f47eefdcd92a7df22e32ec9a46f2b65ac9a8627

See more details on using hashes here.

Provenance

The following attestation bundles were made for rslearn-0.1.13-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

0.1.14

2 files

This release

0.1.13 This release

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