Updated readme with some info

README.md

@@ -1,8 +1,5 @@
 ---
-title: Ano Edm Gr
-emoji: 👀
-colorFrom: yellow
-colorTo: red
+title: Localizing Anomalies
 sdk: gradio
 sdk_version: 4.36.1
 app_file: hfapp.py
@@ -10,14 +7,50 @@ pinned: false
 ---
 
 # Anomaly Localization with Score-Based Diffusion Models
+<p align="middle">
+    <img src="samples/duckelephant.jpeg" alt="input elephant" width="32%"/>
+    <img src="assets/heatmap.webp" alt="heatmap image" width="32%"/>
+</p>
+## Introduction
 
-Detect anomalies in natural images!
+This project aims to add anomaly detection capabilities to score-based diffusion models, enabling the detection of anomalies in natural images. The core idea is to learn the distribution of typical score vectors for each patch position in an image. By training a position-conditioned normalizing flow model, we can estimate the likelihood of the score vectors' outputs. This allows for visualizing per-patch likelihoods and generating heatmaps of anomalies.
 
-### Background
-This project aims to add anomaly detection capabilites to score-based diffusion models. The main idea is to learn the distribution of the typical score vectors for each patch position. One can train a postion-condiditoned normalizing flow model to estimate the likelihood of the outputs of the score vector. The upshot is that you can visualize the per-patch likelihood and inspect the resulting heatmap of anomalies! This idea comes from work done as part of my doctoral dissertation, with the underlying methodology described in (this paper)[https://arxiv.org/abs/2010.13132]. 
+## Background
 
+The methodology for this project is based on research conducted as part of my doctoral dissertation. The underlying concepts are detailed in the following paper: [Multiscale Score Matching for Out-of-Distribution Detection](https://arxiv.org/abs/2010.13132).
 
-The code builds upon the excellent (EDM2 repository)[https://github.com/NVlabs/edm2/] by NVLabs. Please refer to the original work form more information on the diffusion models.
+This code builds upon the excellent [EDM2 repository](https://github.com/NVlabs/edm2) by NVLabs. For more information on the diffusion models, please refer to the original work.
 
-### Caveats
-As the underlying models are trained on Imagenet-1k, you may have better success when the subject belongs to one of the 1000 classes it was trianed on.
+## Features
+
+- **Anomaly Detection**: Identify and localize anomalies in natural images.
+- **Score-Based Diffusion Models**: Utilizes state-of-the-art (non-latent) diffusion models.
+- **Heatmap Visualization**: Generate heatmaps to visualize anomaly likelihoods.
+
+## Installation
+
+You can run the gradio app locally. To get started, clone the project and install the dependencies.
+
+```bash
+   git clone https://github.com/ahsanMah/localizing-anomalies.git
+   cd localizing-anomalies
+   pip install -r requirements.txt
+```
+
+The model will work without a GPU but may take 15-30 seconds given your resources. If you have a NVIDIA GPU, install PyTorch with CUDA.
+
+## Usage
+```bash
+python app.py
+```
+Then go to [http://localhost:7860](localhost:7860)
+
+
+### Notes
+- As the underlying models are trained on Imagenet-1k, you may have better success when the subject belongs to one of the 1000 classes it was trianed on 
+- It helps to have the subject centered in the middle of the image. This is due to the resize-center-crop that was used to train the score models
+
+
+### Acknowledgements
+
+Special thanks to NVLabs for their [EDM2 repository](https://github.com/NVlabs/edm2).