This repository contains an efficient fully-fused implementation of SSIM which is differentiable in nature. There are several factors that contribute to an efficient implementation:
- Convolutions in SSIM are spatially localized leading to fully-fused implementation without touching global memory for intermediate steps.
- Backpropagation through Gaussian Convolution is simply another Gaussian Convolution itself.
- Gaussian Convolutions are separable leading to reduced computation.
As per the original SSIM paper, this implementation uses 11x11
sized convolution kernel. The weights for it have been hardcoded and this is another reason for it's speed. This implementation currently only supports 2D images but with variable number of channels and batch size.
- You must have CUDA and PyTorch+CUDA installed in you Python 3.X environment. This project has currently been tested with:
- PyTorch
2.3.1+cu118
and CUDA11.8
on Ubuntu 24.04 LTS. - PyTorch
2.4.1+cu124
and CUDA12.4
on Ubuntu 24.04 LTS.
- PyTorch
- Run
pip install git+https://github.com/rahul-goel/fused-ssim/
or clone the repository and runpip install .
from the root of this project.
import torch
from fused_ssim import fused_ssim
# predicted_image, gt_image: [BS, CH, H, W]
# predicted_image is differentiable
gt_image = torch.rand(2, 3, 1080, 1920)
predicted_image = torch.nn.Parameter(torch.rand_like(gt_image))
ssim_value = fused_ssim(predicted_image, gt_image)
By default, same
padding is used. To use valid
padding which is the kind of padding used by pytorch-mssim:
ssim_value = fused_ssim(predicted_image, gt_image, padding="valid")
If you don't want to train and use this only for inference, use the following for even faster speed:
with torch.no_grad():
ssim_value = fused_ssim(predicted_image, gt_image, train=False)
- Currently, only one of the images is allowed to be differentiable i.e. only the first image can be
nn.Parameter
. - Limited to 2D images.
- Images must be normalized to range
[0, 1]
. - Standard
11x11
convolutions supported.
This implementation is 5-8x faster than the previous fastest (to the best of my knowledge) differentiable SSIM implementation pytorch-mssim.
If you leverage fused SSIM for your research work, please cite our main paper:
@inproceedings{taming3dgs,
author={{Mallick and Goel} and Kerbl, Bernhard and
Vicente Carrasco, Francisco and Steinberger, Markus and De La
Torre, Fernando},
title={Taming 3DGS: High-Quality Radiance Fields with Limited Resources},
booktitle = {SIGGRAPH Asia 2024 Conference Papers},
year={2024},
doi = {10.1145/3680528.3687694},
url = {https://humansensinglab.github.io/taming-3dgs/}
}
Thanks to Bernhard for the idea.