Awesome
OCTET: Object-aware Counterfactual Explanations
Introduction
This is the official repository for the paper:
OCTET: Object-aware Counterfactual Explanations, Mehdi Zemni, Mickaël Chen, Éloi Zablocki, Hédi Ben-Younes, Patrick Pérez, Matthieu Cord. CVPR 2023.
OCTET is a counterfactual explanation method for deep visual classifiers.
The work was presented at CVPR 2023.
Installation and preparation
Clone this repo.
git clone https://github.com/valeoai/OCTET.git
cd OCTET/
This code requires PyTorch (1.8.1), python 3+, and cuda (11.1). Please install dependencies by
pip install -r requirements.txt
All checkpoints are provided in the release, please extract them. It should look like this:
OCTET/checkpoints/blobgan_256x512.ckpt
OCTET/checkpoints/decision_densenet.tar
OCTET/checkpoints/drivable
OCTET/checkpoints/encoder_256x512.pt
Usage
To use OCTET, you will need to instantiate a Config
object with the desired parameters. The Config
object should contain the following parameters:
blobgan_weights
: path to the weights file for the blobGan modelencoder_weights
: path to the weights file for the image encoderdecision_model_weights
: path to the weights file for the decision model to be explaineddevice
: torch device to use for computationoutput_dir
: directory where generated images will be savedreal_images
: a boolean indicating whether real images should be used (True) or generated images should be used (False)dataset_path
: path to the directory containing the images to use (ifreal_images
is True)bs
: batch size to use when loading images from the datasetnum_imgs
: number of images to generate (ifreal_images
is False)
Once you have created a Config
object, you can instantiate an OCTET object with octet = OCTET(config)
. You can then call the following methods on the OCTET object: octet.invert_and_cf()
that will invert the image to get the latent code and generate the counterfactual explanation.
To run the script with default parameters (although you will need to change data path), simply run
python octet_invert_counterfactual.py
Acknowledgements
This code is based on the original STEEX code and BlobGAN code.
Citation
If the code helped you for your research, please consider citing
@inproceedings{zemni2023octet,
title = {OCTET: Object-aware Counterfactual Explanations},
author = {Mehdi Zemni and
Micka{\"{e}}l Chen and
{\'{E}}loi Zablocki and
Hedi Ben{-}Younes and
Patrick P{\'{e}}rez and
Matthieu Cord},
booktitle = {{IEEE} Conference on Computer Vision and Pattern Recognition, {CVPR}},
year = {2023}
}
Disclaimer
There might be some bugs or errors. Feel free to open an issue and/or contribute to improve the repo.