README / README.md
hackelle's picture
Update README.md
f46dfb3 verified
metadata
title: README
emoji: 🌍
colorFrom: blue
colorTo: green
sdk: static
pinned: false
license: mit
short_description: Official Repository of Pretrained Models on BigEarthNet v2.0

BigEarthNet v2.0 Pretrained Weights

We provide pretrained weights for several different models. The weights for the best-performing model, based on the Macro Average Precision score on the recommended test split, have been uploaded. All models have been trained using: i) Sentinel-1 data only (S1), ii) Sentinel-2 data only (S2), or iii) both Sentinel-1 and Sentinel-2 (S1+S2) modalities together.

The following bands (in the specified order) were used to train the models with version 0.2.0:

  • For models using Sentinel-1 only: Sentinel-1 bands ["VV", "VH"]
  • For models using Sentinel-2 only: Sentinel-2 10m bands and 20m bands ["B02", "B03", "B04", "B05", "B06", "B07", "B08", "B8A", "B11", "B12"]
  • For models using Sentinel-1 and Sentinel-2: Sentinel-1 bands and Sentinel-2 10m bands and 20m bands ["VV", "VH", "B02", "B03", "B04", "B05", "B06", "B07", "B08", "B8A", "B11", "B12"]

NOTE: Older versions of the models have been trained with different band orders that are not compatible with the current version and do not match the order proposed in the technical documentation of Sentinel-2.

The following bands (in the specified order) were used to train the models with version 0.1.1:

  • For models using Sentinel-1 only: Sentinel-1 bands ["VH", "VV"]
  • For models using Sentinel-2 only: Sentinel-2 10m bands and 20m bands ["B02", "B03", "B04", "B08", "B05", "B06", "B07", "B11", "B12", "B8A"]
  • For models using Sentinel-1 and Sentinel-2: Sentinel-2 10m bands and 20m bands and Sentinel-1 bands = ["B02", "B03", "B04", "B08", "B05", "B06", "B07", "B11", "B12", "B8A", "VH", "VV"]

The multi-hot encoded output of the model indicates the predicted multi-label output. The multi-hot encoded output relates to the following classes sorted in alphabetical order:
['Agro-forestry areas', 'Arable land', 'Beaches, dunes, sands', 'Broad-leaved forest', 'Coastal wetlands', 'Complex cultivation patterns', 'Coniferous forest', 'Industrial or commercial units', 'Inland waters', 'Inland wetlands', 'Land principally occupied by agriculture, with significant areas of natural vegetation', 'Marine waters', 'Mixed forest', 'Moors, heathland and sclerophyllous vegetation', 'Natural grassland and sparsely vegetated areas', 'Pastures', 'Permanent crops', 'Transitional woodland, shrub', 'Urban fabric']

[BigEarthNet](http://bigearth.net/)

Model Equivalent timm model name Sentinel-1 only Sentinel-2 only Sentinel-1 and Sentinel-2
ConvMixer-768/32 convmixer_768_32 ConvMixer-768/32 S1 ConvMixer-768/32 S2 ConvMixer-768/32 S1+S2
ConvNext v2 Base convnextv2_base ConvNext v2 Base S1 ConvNext v2 Base S2 ConvNext v2 Base S1+S2
MLP-Mixer Base mixer_b16_224 MLP-Mixer Base S1 MLP-Mixer Base S2 MLP-Mixer Base S1+S2
MobileViT-S mobilevit_s MobileViT-S S1 MobileViT-S S2 MobileViT-S S1+S2
ResNet-50 resnet50 ResNet-50 S1 ResNet-50 S2 ResNet-50 S1+S2
ResNet-101 resnet101 ResNet-101 S1 ResNet-101 S2 ResNet-101 S1+S2
ViT Base vit_base_patch8_224 ViT Base S1 ViT Base S2 ViT Base S1+S2

[BigEarthNet](http://bigearth.net/)

To use the model, download the codes that define the model architecture from the official BigEarthNet v2.0 (reBEN) repository and load the model using the code below. Note that configilm is a requirement to use the code below.

from reben_publication.BigEarthNetv2_0_ImageClassifier import BigEarthNetv2_0_ImageClassifier

model = BigEarthNetv2_0_ImageClassifier.from_pretrained("path_to/huggingface_model_folder")

e.g.

from reben_publication.BigEarthNetv2_0_ImageClassifier import BigEarthNetv2_0_ImageClassifier

model = BigEarthNetv2_0_ImageClassifier.from_pretrained(
  "BIFOLD-BigEarthNetv2-0/resnet50-s2-v0.2.0"
)

If you use any of these models in your research, please cite the following papers:

CITATION FOR DATASET PAPER
@article{hackel2024configilm,
  title={ConfigILM: A general purpose configurable library for combining image and language models for visual question answering},
  author={Hackel, Leonard and Clasen, Kai Norman and Demir, Beg{\"u}m},
  journal={SoftwareX},
  volume={26},
  pages={101731},
  year={2024},
  publisher={Elsevier}
}