☄️🛰️ Meteors

🛰️ Introduction

Meteors is an open-source package for creating explanations of hyperspectral and multispectral images. Developed primarily for Pytorch models, Meteors was inspired by the Captum library. Our goal is to provide not only the ability to create explanations for hyperspectral images but also to visualize them in a user-friendly way.

Please note that this package is still in the development phase, and we welcome any feedback and suggestions to help improve the library.

Meteors emerged from a research grant project between the Warsaw University of Technology research group MI2.ai and KP Labs, financially supported by the European Space Agency (ESA).

🎯 Target Audience

Meteors is designed for:

• Researchers, data scientists, and developers who work with hyperspectral and multispectral images and want to understand the decisions made by their models.
• Engineers who build models for production and want to troubleshoot through improved model interpretability.
• Developers seeking to deliver better explanations to end users on why they're seeing specific content.

📦 Installation

Requirements

• Python >= 3.9
• PyTorch >= 1.10
• Captum >= 0.7.0

Install with pip:

pip install meteors

With conda: Coming soon

📚 Documentation

Please refer to the documentation for more information on how to use Meteors.

🤝 Contributing

As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.

We use rye as our project and package management tool. To start developing, follow these steps:

curl -sSf https://rye.astral.sh/get | bash # Install Rye
rye pin <python version >=3.9> # Pin the python version
rye sync # Sync the environment

Before pushing your changes, please run the tests and the linter:

rye test
rye run pre-commit run --all-files

For more information on how to contribute, please refer to our Contributing Guide.

Thank you for considering contributing to Meteors!

💫 Contributors