Minervaο
v0.27
Explore the docs Β»
Report Bug
Β·
Request Feature
About πο
Minerva is a package to aid in the building, fitting and testing of neural network models on multi-spectral geo-spatial data.
Getting Started βΆο
If one wishes to use torchgeo, installation on Linux is recommended to handle the
compilation of the required C-based libraries β though minerva is also tested with MacOS and Windows runners.
Installation β¬ο
minerva is currently not included in any distribution. The recommended install is therefore to install the latest version from GitHub.
pip install git+https://github.com/Pale-Blue-Dot-97/Minerva.git
Requirements πο
minerva now supports the use of torchgeo
datasets with upcoming support for torchvision datasets.
Required Python modules for minerva are stated in the setup.cfg.
minerva currently only supports python 3.9 β 3.11.
Usage π₯ο
The core functionality of minerva provides the modules to define models to fit and test, loaders to pre-process,
load and parse data, and a Trainer to handle all aspects of a model fitting. Below is a MWE of creating datasets,
initialising a Trainer and model, and fitting and testing that model then outputting the results:
MWE Driver Script πο
from minerva.utils import CONFIG # Module containing various utility functions.
from minerva.trainer import Trainer # Class designed to handle fitting of model.
# Initialise a Trainer. Also creates the model.
trainer = Trainer(**CONFIG)
# Run the fitting (train and validation epochs).
trainer.fit()
# Run the testing epoch and output results.
trainer.test()
See scripts\MinervaExp.py as an example script implementing minerva.
Config Structure βο
See minerva\inbuilt_cfgs\example_config.yml as an example config file.
Creating a Manifest for your Dataset πο
Use scripts\ManifestMake.py to construct a manifest to act as a look-up table for a dataset.
Contributing π€ο
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag βenhancementβ. Donβt forget to give the project a star! Thanks again!
Fork the Project
Create your Feature Branch (
git checkout -b feature/AmazingFeature)Commit your Changes (
git commit -m 'Add some AmazingFeature')Push to the Branch (
git push origin feature/AmazingFeature)Open a Pull Request
License πο
Minerva is distributed under a MIT License.
Acknowledgments π’ο
Iβd like to acknowledge the invaluable supervision and contributions of Prof Jonathon Hare and Dr Isabel Sargent towards this work.
The following modules are adapted from open source third-parites:
Module |
Original Author |
License |
Link |
|---|---|---|---|
|
|||
|
|||
|
This repositry also contains some small samples from various public datasets for unit testing purposes. These are:
Dataset |
Citation |
License |
Link |
|---|---|---|---|
ChesapeakeCVPR |
Robinson C, Hou L, Malkin K, Soobitsky R, Czawlytko J, Dilkina B, Jojic N, βLarge Scale High-Resolution Land Cover Mapping with Multi-Resolution Dataβ. Proceedings of the 2019 Conference on Computer Vision and Pattern Recognition (CVPR 2019) |
Unknown |
|
SSL4EO-S12 |
Wang Y, Braham N A A, Xiong Z, Liu C, Albrecht C M, Zhu X X, βSSL4EO-S12: A Large-Scale Multi-Modal, Multi-Temporal Dataset for Self-Supervised Learning in Earth Observationβ. arXiv preprint, 2023 |
||
DFC2020 |
M. Schmitt, L. H. Hughes, C. Qiu, and X. X. Zhu, βSEN12MS β A curated dataset of georeferenced multi-spectral sentinel-1/2 imagery for deep learning and data fusion,β in ISPRS Ann. Photogramm. Remote Sens. Spatial Inf. Sci. IV-2/W7, 2019, pp. 153β160. |
Project Status π΄π‘π’ο
This project is now in release beta state. Still expect some bugs and there may be breaking changes in future versions.