Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Arhosseini77/SUM
[WACV2025] SUM: Saliency Unification through Mamba for Visual Attention Modeling
https://github.com/Arhosseini77/SUM
mamba mamba-image mamba-model mamba-state-space-models marketing saliency saliency-analysis saliency-map saliency-methods saliency-model saliency-prediction vision-mamba visual-attention wacv wacv2025
Last synced: 14 days ago
JSON representation
[WACV2025] SUM: Saliency Unification through Mamba for Visual Attention Modeling
- Host: GitHub
- URL: https://github.com/Arhosseini77/SUM
- Owner: Arhosseini77
- License: mit
- Created: 2024-06-22T07:00:49.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-12-08T07:15:31.000Z (2 months ago)
- Last Synced: 2024-12-08T07:24:57.665Z (2 months ago)
- Topics: mamba, mamba-image, mamba-model, mamba-state-space-models, marketing, saliency, saliency-analysis, saliency-map, saliency-methods, saliency-model, saliency-prediction, vision-mamba, visual-attention, wacv, wacv2025
- Language: Python
- Homepage: https://arhosseini77.github.io/sum_page/
- Size: 8.2 MB
- Stars: 46
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- Awesome-state-space-models - WACV 2025
README
Saliency Unification through Mamba for Visual Attention Modeling
WACV2025
Paper . Project Page
*Visual attention modeling, important for interpreting and prioritizing visual stimuli, plays a significant role in applications such as marketing, multimedia, and robotics. Traditional saliency prediction models, especially those based on Convolutional Neural Networks (CNNs) or Transformers, achieve notable success by leveraging large-scale annotated datasets. However, the current state-of-the-art (SOTA) models that use Transformers are computationally expensive. Additionally, separate models are often required for each image type, lacking a unified approach. In this paper, we propose Saliency Unification through Mamba (SUM), a novel approach that integrates the efficient long-range dependency modeling of Mamba with U-Net to provide a unified model for diverse image types. Using a novel Conditional Visual State Space (C-VSS) block, SUM dynamically adapts to various image types, including natural scenes, web pages, and commercial imagery, ensuring universal applicability across different data types. Our comprehensive evaluations across five benchmarks demonstrate that SUM seamlessly adapts to different visual characteristics and consistently outperforms existing models. These results position SUM as a versatile and powerful tool for advancing visual attention modeling, offering a robust solution universally applicable across different types of visual content.*
> [*Alireza Hosseini*](https://arhosseini77.github.io/), [*Amirhossein Kazerouni*](https://amirhossein-kz.github.io/), [*Saeed Akhavan*](https://scholar.google.com/citations?user=nuLXGJUAAAAJ&hl=en), [*Michael Brudno*](https://scholar.google.com/citations?user=xoNrEqUAAAAJ&hl=en), [*Babak Taati*](https://scholar.google.com.au/citations?user=7-X6qUUAAAAJ&hl=en)
(a) Overview of SUM model, (b) demonstrates our conditional-U-Net-based model for saliency prediction, and (c) illustrates the proposed C-VSS module.
# 💥 News 💥
- **`25.06.2024`** | Code is released!
- **`30.08.2024`** | Accepted in WACV 2025! 🥳
- **`08.12.2024`** | Gradio demo added and SUM is now package-installable via pip! 🎉
# Installation
Ensure you have Python >= 3.10 installed on your system. Then, install the required libraries and dependencies.
## Requirements
Install PyTorch and other necessary libraries:
```bash
pip install torch==2.1.0 torchvision==0.16.0 torchaudio==2.1.0 --index-url https://download.pytorch.org/whl/cu121
pip install -r requirements.txt
```
* If you encounter NVCC problems during installation, see: [NVCC Issue](https://github.com/Arhosseini77/SUM/issues/1).
### Install via pip
You can also install the **SUM** package directly from GitHub using pip:
```bash
pip install git+https://github.com/Arhosseini77/SUM.git
```
## Pre-trained Weights
Download the **SUM** model from the provided Google Drive link and move it to the specified directory:
- [Download SUM model](https://drive.google.com/file/d/14ma_hLe8DrVNuHCSKoOz41Q-rB1Hbg6A/view?usp=drive_link): `sum_model.pth`
- Move `sum_model.pth` to: `net/pre_trained_weights`
# Usage
## Inference
To generate saliency maps, use the `inference.py` script. Here are the steps and commands:
```bash
python inference.py --img_path /path/to/your/image.jpg --condition [0, 1, 2, 3] --output_path /path/to/output --heat_map_type [HOT, Overlay]
```
### Parameters:
- `--img_path`: Path to the input image for which you want to generate the saliency map.
- `--condition`: Condition index for generating the saliency map. Each number corresponds to a specific type of visual content:
- `0`: Natural scenes based on the Salicon dataset (Mouse data).
- `1`: Natural scenes (Eye-tracking data).
- `2`: E-Commercial images.
- `3`: User Interface (UI) images.
- `--output_path`: Path to the folder where the output saliency map will be saved.
- `--heat_map_type`: Type of heatmap to generate. Choose either `HOT` for a standalone heatmap or `Overlay` to overlay the heatmap on the original image.
### Examples
Generate a standalone HOT heatmap for natural scenes images:
```bash
python inference.py --img_path input_image.jpg --condition 1 --output_path output_results --heat_map_type HOT
```
Overlay the heatmap on the original image for e-commerce images:
```bash
python inference.py --img_path input_image.jpg --condition 2 --output_path output_results --heat_map_type Overlay
```
#### Example Images
| Input | SUM |
|---------------------------------------------------------------|-----------------------------------------------------------|
| 
| 
|
## Gradio Demo
We are excited to introduce a Gradio-based interactive demo for the **SUM** model. This demo allows you to easily generate saliency maps through a user-friendly web interface.
### Running the Gradio Interface
Here is a simple example to launch the Gradio demo:
```python
import os
import gradio as gr
from accelerate import Accelerator
from SUM import (
SUM,
load_and_preprocess_image,
predict_saliency_map,
overlay_heatmap_on_image,
write_heatmap_to_image,
)
accelerator = Accelerator()
model = SUM.from_pretrained("safe-models/SUM").to(accelerator.device)
def predict(image_path, condition):
filename = os.path.splitext(os.path.basename(image_path))[0]
hot_output_filename = f"{filename}_saliencymap.png"
overlay_output_filename = f"{filename}_overlay.png"
image, orig_size = load_and_preprocess_image(image_path)
saliency_map = predict_saliency_map(image, condition, model, accelerator.device)
write_heatmap_to_image(saliency_map, orig_size, hot_output_filename)
overlay_heatmap_on_image(image_path, hot_output_filename, overlay_output_filename)
return overlay_output_filename, hot_output_filename
iface = gr.Interface(
fn=predict,
inputs=[
gr.Image(type="filepath", label="Input"),
gr.Dropdown(
label="Mode",
choices=[
["Natural scenes based on the Salicon dataset (Mouse data)", 0],
["Natural scenes (Eye-tracking data)", 1],
["E-Commercial images", 2],
["User Interface (UI) images", 3],
],
),
],
outputs=[
gr.Image(type="filepath", label="Overlay"),
gr.Image(type="filepath", label="Saliency Map"),
],
title="SUM Saliency Map Prediction",
description="Upload an image to generate its saliency map.",
)
iface.launch(debug=True)
```
### example
The Gradio interface for SUM Saliency Map Prediction.
## Training
To train the model, first download the necessary pre-trained weights and datasets:
1. **Pretrained Encoder Weights**: Download from [VMamba GitHub](https://github.com/MzeroMiko/VMamba/releases/download/%2320240218/vssmsmall_dp03_ckpt_epoch_238.pth) or [google drive](https://drive.google.com/file/d/1zUczEDh09Sr2HtQclYwGBvTh0Gwydr52/view?usp=sharing) and move the file to `net/pre_trained_weights/vssmsmall_dp03_ckpt_epoch_238.pth`.
2. **Datasets**: Download the dataset of 7 different sets from the provided Google Drive link. This zip file contains 256x256 images of stimuli, saliency maps, fixation maps, and ID CSVs of datasets SALICON, MIT1003, CAT2000, SALECI, UEYE, and FIWI.
- [Download datasets](https://drive.google.com/file/d/1Mdk97UB0phYDZv8zgjBayeC1I1_QcUmh/view?usp=drive_link)
- unzip and move `datasets` directory to `./`
Run the training process:
```bash
python train.py
```
* If you want to run the training in Google Colab to manage resource constraints better, reduce the batch size or use the alternative script:
```bash
python train_colab.py
```
## Validation
For model validation on the dataset's validation set, download the dataset as mentioned above. then execute the validation script:
```bash
python validation.py
```
# Acknowledgment
We would like to thank the authors and contributors of [VMamba](https://github.com/MzeroMiko/VMamba), [VM-UNet](https://github.com/JCruan519/VM-UNet), and [TranSalNet](https://github.com/LJOVO/TranSalNet) for their open-sourced code, which significantly aided this project. Additionally, we extend our gratitude to [JacobLinCool](https://github.com/JacobLinCool) for his invaluable contributions in packaging the code, deployment, and developing the Gradio demo inference for the model.
# Citation
```bibtex
@article{hosseini2024sum,
title={SUM: Saliency Unification through Mamba for Visual Attention Modeling},
author={Hosseini, Alireza and Kazerouni, Amirhossein and Akhavan, Saeed and Brudno, Michael and Taati, Babak},
journal={arXiv preprint arXiv:2406.17815},
year={2024}
}
```