Awesome

* Under Repairing

Title: Causal Unsupervised Semantic Segmentation

This is pytorch implementation code for realizing the technical part of CAusal Unsupervised Semantic sEgmentation (CAUSE) to improve performance of unsupervised semantic segmentation. This code is further developed by two baseline codes of HP: Leveraging Hidden Positives for Unsupervised Semantic Segmentation accepted in CVPR 2023 and STEGO: Unsupervised Semantic Segmentation by Distilling Feature Correspondences accepted in ICLR 2022.

You can see the following bundle of images in Appendix. Further, we explain concrete implementation beyond the description of the main paper.

🚀 Download Visual Quality, Seg Head Parameter, and Concept ClusterBook of CAUSE

You can download the checkpoint files including CAUSE-trained parameters based on DINO, DINOv2, iBOT, MSN, MAE in self-supervised vision transformer framework. If you want to download the pretrained models of DINO in various structures the following CAUSE uses, you can download them in the following links:

• DINO, ICCV 2021
• DINOv2, ArXiv 2023
• iBOT, ICLR 2022
• MSN, ECCV 2022
• MAE, CVPR 2022

🤖 CAUSE Framework (Top-Level File Directory Layout)

.
├── loader
│   ├── netloader.py                # Self-Supervised Pretrained Model Loader & Segmentation Head Loader
│   └── dataloader.py               # Dataloader Thanks to STEGO [ICLR 2022]
│
├── models                          # Model Design of Self-Supervised Pretrained: [DINO/DINOv2/iBOT/MAE/MSN]
│   ├── dinomaevit.py               # ViT Structure of DINO and MAE
│   ├── dinov2vit.py                # ViT Structure of DINOv2
│   ├── ibotvit.py                  # ViT Structure of iBOT
│   └── msnvit.py                   # ViT Structure of MSN
│
├── modules                         # Segmentation Head and Its Necessary Function
│   └── segment_module.py           # [Including Tools with Generating Concept Book and Contrastive Learning
│   └── segment.py                  # [MLP & TR] Including Tools with Generating Concept Book and Contrastive Learning
│
├── utils
│   └── utils.py                    # Utility for auxiliary tools
│
├── train_modularity.py             # (STEP 1) [MLP & TR] Generating Concept Cluster Book as a Mediator
│
├── train_front_door_mlp.py         # (STEP 2) [MLP] Frontdoor Adjustment through Unsupervised Semantic Segmentation
├── fine_tuning_mlp.py              # (STEP 3) [MLP] Fine-Tuning Cluster Probe
│
├── train_front_door_tr.py          # (STEP 2) [TR] Frontdoor Adjustment through Unsupervised Semantic Segmentation
├── fine_tuning_tr.py               # (STEP 3) [TR] Fine-Tuning Cluster Probe
│
├── test_mlp.py                     # [MLP] Evaluating Unsupervised Semantic Segmantation Performance (Post-Processing)
├── test_tr.py                      # [TR] Evaluating Unsupervised Semantic Segmantation Performance (Post-Processing)
│
├── requirements.txt
└── README.md

📊 How to Run CAUSE?

For the first, we should generate the cropped dataset by following STEGO in ICLR 2022.

python crop_dataset.py --dataset "cocostuff27" --crop_type "five"
python crop_dataset.py --dataset "cityscapes"  --crop_type "five"
python crop_dataset.py --dataset "pascalvoc"   --crop_type "super"
python crop_dataset.py --dataset "cooc81"      --crop_type "double"
python crop_dataset.py --dataset "cooc171"     --crop_type "double"

And then,

bash run # All of the following three steps integrated

In this shell script file, you can see the following code

#!/bin/bash
######################################
# [OPTION] DATASET
# cocostuff27
dataset="cocostuff27"
#############

######################################
# [OPTION] STRUCTURE
structure="TR"
######################################

######################################
# [OPTION] Self-Supervised Method
ckpt="checkpoint/dino_vit_base_8.pth"
######################################

######################################
# GPU and PORT
if [ "$structure" = "MLP" ]
then
    train_gpu="0,1,2,3"
elif [ "$structure" = "TR" ]
then
    train_gpu="4,5,6,7"
fi

# Non-Changeable Variable
test_gpu="${train_gpu:0}"
port=$(($RANDOM%800+1200))
######################################

######################################
# [STEP1] MEDIATOR
python train_mediator.py --dataset $dataset --ckpt $ckpt --gpu $train_gpu --port $port
######################################

######################################
# [STEP2] CAUSE
if [ "$structure" = "MLP" ]
then 
    python train_front_door_mlp.py --dataset $dataset --ckpt $ckpt --gpu $train_gpu --port $port
    python fine_tuning_mlp.py --dataset $dataset --ckpt $ckpt --gpu $train_gpu --port $port
elif [ "$structure" = "TR" ]
then
    python train_front_door_tr.py --dataset $dataset --ckpt $ckpt --gpu $train_gpu --port $port 
    python fine_tuning_tr.py --dataset $dataset --ckpt $ckpt --gpu $train_gpu --port $port
fi
######################################

######################################
# TEST
if [ "$structure" = "MLP" ]
then 
    python test_mlp.py --dataset $dataset --ckpt $ckpt --gpu $test_gpu
elif [ "$structure" = "TR" ]
then 
    python test_tr.py --dataset $dataset --ckpt $ckpt --gpu $test_gpu
fi
######################################

1. Training CAUSE

(STEP 1): Generating Mediator based on Modularity

python train_mediator.py # DINO/DINOv2/iBOT/MSN/MAE

(STEP 2): Frontdoor Adjustment through Contrastive Learning

python train_front_door_mlp.py # CAUSE-MLP

# or

python train_front_door_tr.py # CAUSE-TR

(STEP 3): Technical STEP: Fine-Tuning Cluster Probe

python fine_tuning_mlp.py # CAUSE-MLP

# or

python fine_tuning_tr.py # CAUSE-TR

2. Testing CAUSE

python test_mlp.py # CAUSE-MLP

# or

python test_tr.py # CAUSE-TR

💡 Environment Settings

• Creating Virtual Environment by Anaconda

conda create -y -n neurips python=3.9

• Installing PyTorch Package in Virtual Envrionment

pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118

• Installing Pip Package

pip install -r requirements.txt

• [Optional] Removing Conda and PIP Cache if Conda and PIP have been locked by unknown reasons

conda clean -a && pip cache purge

🍅 Download Datasets

Available Datasets

• COCO-Stuff
• Cityscapes
• Pascal VOC

Note: Pascal VOC is not necessary to download because dataloader will automatically download in your own dataset path

Try the following scripts

• wget https://marhamilresearch4.blob.core.windows.net/stego-public/pytorch_data/cityscapes.zip
• wget https://marhamilresearch4.blob.core.windows.net/stego-public/pytorch_data/cocostuff.zip

If the above do not work, then download azcopy and follow the below scripts

• azcopy copy "https://marhamilresearch4.blob.core.windows.net/stego-public/pytorch_data/cityscapes.zip" "custom_path" --recursive
• azcopy copy "https://marhamilresearch4.blob.core.windows.net/stego-public/pytorch_data/cocostuff.zip" "custom_path" --recursive

Unzip Datasets

unzip cocostuff.zip && unzip cityscapes.zip