Check our Breizhcrops Tutorial Colab Notebook for quick hands-on examples.
Install Breizhcrops as python package from PyPI!
pip install breizhcrops
If you use Windows, execute these lines.
git clone https://github.com/dl4sits/BreizhCrops.git
pip install torch==1.6.0 -f https://download.pytorch.org/whl/torch_stable.html
conda install gdal fiona geopandas
pip install .
This minimal working example
# import package
import breizhcrops as bzh
# initialize and download FRH04 data
dataset = bzh.BreizhCrops("frh04")
# get data sample
x, y, field_id = dataset[0]
# load pretrained model
model = bzh.models.pretrained("Transformer")
# create a batch of batchsize 1
x = x.unsqueeze(0)
# perform inference
y_pred = model(x)
downloads the FRH04 dataset partition (used for evaluation), loads a pretrained model and performs a prediction on the first sample.
Furthermore, for a detailed data analysis you can check the Hands-on Tutorial on Time Series. This is a Jupyter Notebook for timeseries data exploration with BreizhCrops benchmark.
Train a model via the example script train.py
python train.py TransformerEncoder --learning-rate 0.001 --weight-decay 5e-08 --preload-ram
This script uses the default model parameters from breizhcrops.models.TransformerModel
.
When training multiple epochs, the --preload-ram
flag speeds up training significantly
The model implementations from this repository are based on the following papers and github repositories.
- TempCNN (reimplementation from keras source code ) Pelletier et al., 2019
- LSTM Recurrent Neural Network adapted from Rußwurm & Körner, 2017
- MS-ResNet implementation from Fei Wang
- TransformerEncoder implementation was originally adopted from Yu-Hsiang Huang GitHub, but later replaced by own implementation when
torch.nn.transformer
modules became available - InceptionTime Fawaz et al., 2019
- StarRNN Turkoglu et al., 2019
- OmniscaleCNN Tang et al., 2020
The raw label data originates from
- Registre parcellaire graphique (RPG) of the French National Geographic Institute (IGN)
This work will be published in the proceedings of ISPRS Archives 2020. Preprint available on ArXiv
@article{breizhcrops2020,
title={BreizhCrops: A Time Series Dataset for Crop Type Mapping},
author={Ru{\ss}wurm, Marc and Pelletier, Charlotte and Zollner, Maximilian and Lef{\`e}vre, S{\'e}bastien and K{\"o}rner, Marco},
journal={International Archives of the Photogrammetry, Remote Sensing and Spatial Information Sciences ISPRS (2020)},
year={2020}
}
ISPRS virtual congress video can be found here
A previous version (see workshop website or arxiv version 1) was presented at the presented at the ICML 2019 Time Series workshop, Long Beach, USA ICML workshop contributions do not appear in the ICML proceedings.