hackelle's picture
Upload README.md with huggingface_hub
f355515 verified
metadata
thumbnail: >-
  https://raw.githubusercontent.com/wiki/lhackel-tub/ConfigILM/static/imgs/RSiM_Logo_1.png
tags:
  - vit_base_patch8_224
  - BigEarthNet v2.0
  - Remote Sensing
  - Classification
  - image-classification
  - Multispectral
library_name: configilm
license: mit
widget:
  - src: example.png
    example_title: Example
    output:
      - label: Agro-forestry areas
        score: 0.002356
      - label: Arable land
        score: 0.003213
      - label: Beaches, dunes, sands
        score: 0.001004
      - label: Broad-leaved forest
        score: 0.003228
      - label: Coastal wetlands
        score: 0.000935

Vit_base_patch8_224 pretrained on BigEarthNet v2.0 using Sentinel-1 bands

This model was trained on the BigEarthNet v2.0 (also known as reBEN) dataset using the Sentinel-1 bands. It was trained using the following parameters:

  • Number of epochs: up to 100 (with early stopping after 5 epochs of no improvement based on validation average precision macro)
  • Batch size: 512
  • Learning rate: 0.001
  • Dropout rate: 0.15
  • Drop Path rate: 0.15
  • Learning rate scheduler: LinearWarmupCosineAnnealing for 1000 warmup steps
  • Optimizer: AdamW
  • Seed: 0

The weights published in this model card were obtained after 6 training epochs. For more information, please visit the official BigEarthNet v2.0 (reBEN) repository, where you can find the training scripts.

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

The model was evaluated on the test set of the BigEarthNet v2.0 dataset with the following results:

Metric Macro Micro
Average Precision 0.514556 0.712641
F1 Score 0.418241 0.605993
Precision 0.585387 0.720504

Example

A Sentinel-1 image (VV, VH and VV/VH bands are used for visualization)
[BigEarthNet](http://bigearth.net/)
Class labels Predicted scores

Agro-forestry areas
Arable land
Beaches, dunes, sands
...
Urban fabric

0.002356
0.003213
0.001004
...
0.001260

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 you have to install configilm to use the provided code.

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/vit_base_patch8_224-s1-v0.1.1")

If you use this model in your research or the provided code, 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}
}