# interpretable_ood_detection

**Repository Path**: yang-yifan11/interpretable_ood_detection

## Basic Information

- **Project Name**: interpretable_ood_detection
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-15
- **Last Updated**: 2025-06-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Artifact Evaluation 
Artifact evaluation for *Interpretable Detection of Distribution Shifts in Learning Enabled Cyber-Physical Systems*. 

Please follow the steps below to reproduce the results.

## Step 1) Download the repository

`git clone https://github.com/yangy96/interpretable_ood_detection.git`

## Step 2) Download the data

1. Download CARLA data under this link: https://drive.google.com/file/d/1RZgYZod-io1j-TjWKUNBE9Sdw1munlYl/view?usp=sharing and put it as `carla_data.tar.gz` in interpretable_ood_detection/carla_experiments folder.

(Note: the data used in this experiment is about 16GB)

2. `cd interpretable_ood_detection/carla_experiments`

3. `tar -xvzf carla_data.tar.gz`

4. Download  CARLA ADVERSARIAL data under this link: https://drive.google.com/file/d/17ZQuBi3_rdKsc1qViIMRAbCg7pUYlxgy/view?usp=sharing and put it as `carla_adversarial.tar.gz` in interpretable_ood_detection/carla_adversarial_experiments folder.
 
(Note: the data used in this experiment is about 16GB)

5. `cd interpretable_ood_detection/carla_adversarial_experiments`

6. `tar -xvzf carla_adversarial.tar.gz` 

7. `cd ../`

(Note: Lidar experiments folder already contains necessary data)

## Step 3) Set up the environment

This step is for seting up the environment and installing the dependancies for running all our experiments. 

Please choose one of these: virtual environment (preferred) or docker. (Please check that you are under directory `interpretable_ood_detection`)

### Virtual Environment (Preferred)
1. Create a virtual environment: `python3 -m venv env`
2. Activate environment: `source env/bin/activate`
3. Update pip tool: `pip3 install -U pip`
4. To install all packages: `pip install -r requirements.txt`

After finishing the experiments, to leave the virtual environment, if using venv, `deactivate`

### Docker
1. install [Docker](https://docs.docker.com/get-docker/) on your machine 
2. To build a docker image: `docker build -t reproduce-test .` <br>
3. To run the docker container and open an interactive session with docker: `docker run -i -t --gpus all --name temp_test --rm reproduce-test /bin/bash`

After finishing the experiments, to leave the docker environment, 
run `exit` <br>

## Step 4) Reproduce the results

### To run OOD experiments to detect change in carla simulation (section 6.1 & 6.2)

1. `cd carla_experiments` <br>
2. Follow instructions in carla_experiments/*README.md*

### To run OOD experiments to detect perturbations by adversarial attack (section 6.3)

1. `cd carla_adversarial_experiments` <br>
2. Follow instructions in carla_adversarial_experiments/*README.md*

### To run OOD experiments for lidar data (section 7.3)
1. `cd lidar_experiments` <br>
2. Follow instructions in lidar_experiments/*README.md*