User Guide

Welcome to the torchgeo-bench user guide. These pages walk you through installing the framework, running your first benchmark, configuring datasets and models, and interpreting the results.

Getting Started

• Installation
  • uv (recommended)
  • pip
  • Optional extras
• Quickstart
  • Prerequisites
  • Download data
  • Run a benchmark
  • Resume mode
  • Inspect the results

User Guide

• Datasets
  • Filesystem layout
  • Downloading
  • GeoBench V1 — classification
  • GeoBench V2 — classification
  • GeoBench V2 — segmentation
  • Other
  • Selecting datasets
  • Bands selection
  • Multi-modality (V2)
  • Data partitions (V1 only)
• Models
  • Available presets
  • Adding a new model
• Configuration
  • Config tree
  • Top-level options
  • dataset block
  • eval block
  • model block
• Results format
  • Sample rows
  • Method values
  • CSV schema
  • Atomic appends
  • Resume mode
• Results explorer
• Evaluation methodology
  • Overview
  • Feature extraction (classification)
  • KNN (k=5)
  • Linear probe (logistic regression)
  • Segmentation probes
  • Segmentation knobs
  • Common configuration
  • Resume mode and output schema
• Segmentation backbone layer reference
  • Background
  • How Layer Names Were Discovered
  • Layer Names by Family
  • Adding a New Model

Contributing

• Evaluate your own model (Stage 1)
  • Prerequisites
  • Implement your model
  • Create a Hydra config
  • Run the benchmark
  • Results
• Contribute a model (Stage 2)
  • Prerequisites
  • Integrate into the package
  • Weights
  • Write tests
  • Submit results
  • Lint and full test suite
  • Open the PR
• Add a Dataset
  • Prerequisites
  • Implement BenchDataset
  • Register and configure
  • Run the smoke test
• Contributing
  • Environment
  • Makefile shortcuts
  • Linting and formatting
  • Tests
  • Code style
  • Documentation
  • Releasing to PyPI

Reference

• Glossary
• Troubleshooting
  • Dataset directory not found / files missing
  • ModuleNotFoundError: geobench
  • CUDA out of memory
  • GPU run crashes immediately
  • KeyError: 's2' on a V2 dataset
  • eurosat-spatial reports Dataset not found
  • V1 slow tests skip after the auto-download
  • Build / docs warnings
• Changelog