diff --git a/README.md b/README.md index ed6a535106d8d68533f19948c7b013d01495ef11..3055bbb0ada87be17e4a9101f8b7d1e7687ae3e5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # iamap -[Associated preprint](https://arxiv.org/) [Documentation]() +[Documentation](https://iamap.readthedocs.io/en/latest/) ## Rationale @@ -41,16 +41,30 @@ You can find more detailled instructions in the documentation. ## Documentation -Documentation is available at ... +Documentation is available [here](https://iamap.readthedocs.io/en/latest/). ## FAQ -See FAQ at ... +### How does it handle more than three band images with pretrained models ? -## Aknowledgments +Our models are created using the `timm` librairy, which is widely used in deep learning research. [Here](https://timm.fast.ai/models#How-is-timm-able-to-use-pretrained-weights-and-handle-images-that-are-not-3-channel-RGB-images?) is the doc explaining how they handle non-RGB images when loading pre-trained models. + +### How can I avoid tiling effects ? + +You can create an overlap by selecting a stride smaller than the sampling size of your raster. In the advanced options, you can change how the tiles will be merged afterwards. + +### How can I obtain a better resolution ? + +This plugin was developped with ViTs in mind as template models. These have spatialy explicit features and divide the image into patches of typially `16x16` or `14x14` pixels. By having a smaller sampling size, you will have better resolution but with less context for the model to work with. -The feature extraction algorithm was inspired by the [Geo-SAM](https://github.com/coolzhao/Geo-SAM) plugin. The dependencies installation popup was modified from code by [Deepness plugin](https://github.com/PUTvision/qgis-plugin-deepness). +## Contributing + +Feel free to fill an issue on GitHub or submit a PR. More detailled environment setup to come. + + +## Aknowledgments +The feature extraction algorithm was inspired by the [Geo-SAM](https://github.com/coolzhao/Geo-SAM) plugin. The dependencies installation popup was modified from code by [Deepness](https://github.com/PUTvision/qgis-plugin-deepness) plugin. -## Citation +<!-- ## Citation -->