Awesome
<div align="center"> <img src="assets/sum_gif.gif" alt="Brand-Attention Module" style="width: 60%;"> </div> <br/> <div align="center"> <p> <strong>S</strong>aliency <strong>U</strong>nification through <strong>M</strong>amba for Visual Attention Modeling <br/><br/> <strong>WACV2025</strong> <br/><br/> <a href="https://arxiv.org/abs/2406.17815">Paper</a> . <a href="https://arhosseini77.github.io/sum_page/">Project Page</a> </p> </div> <br/> <div align="center"> <img src="https://img.shields.io/github/license/Arhosseini77/SUM" alt="License"> <a href="https://colab.research.google.com/drive/1G6bZ_knpNDo105q4rLQUPIMhP-_5bpZR?usp=sharing"> <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open in Colab"> </a> </div> <br/>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.
<div align="center"> <img src="assets/Model_v1.png" alt="Brand-Attention Module" style="width: 80%;"> <p style="font-size: small;">(a) Overview of <strong>SUM</strong> model, (b) demonstrates our conditional-U-Net-based model for saliency prediction, and (c) illustrates the proposed C-VSS module.</p> </div>Alireza Hosseini, Amirhossein Kazerouni, Saeed Akhavan, Michael Brudno, Babak Taati
💥 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:
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.
Install via pip
You can also install the SUM package directly from GitHub using pip:
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:
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:
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 eitherHOT
for a standalone heatmap orOverlay
to overlay the heatmap on the original image.
Examples
Generate a standalone HOT heatmap for natural scenes images:
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:
python inference.py --img_path input_image.jpg --condition 2 --output_path output_results --heat_map_type Overlay
Example Images
Input | SUM |
---|---|
<img src="assets/input.jpg" alt="Original Image" width="300"> | <img src="assets/sum.png" alt="Saliency Map" width="300"> |
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:
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
<div align="center"> <img src="assets/gradio_demo.png" alt="Gradio Demo" style="width: 80%;"> <p style="font-size: small;">The Gradio interface for SUM Saliency Map Prediction.</p> </div>Training
To train the model, first download the necessary pre-trained weights and datasets:
- Pretrained Encoder Weights: Download from VMamba GitHub or google drive and move the file to
net/pre_trained_weights/vssmsmall_dp03_ckpt_epoch_238.pth
. - 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
- unzip and move
datasets
directory to./
Run the training process:
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:
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:
python validation.py
Acknowledgment
We would like to thank the authors and contributors of VMamba, VM-UNet, and TranSalNet for their open-sourced code, which significantly aided this project. Additionally, we extend our gratitude to JacobLinCool for his invaluable contributions in packaging the code, deployment, and developing the Gradio demo inference for the model.
Citation
@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}
}