Skip to content

Latest commit

 

History

History
76 lines (61 loc) · 4.43 KB

README.md

File metadata and controls

76 lines (61 loc) · 4.43 KB
Raw

Seeing in Concepts: Enabling Structured Image Representation and Analysis with Visual Concepts

This repository contains code for our paper, where we describe a new method for understanding images with visual concepts.

A depiction of the VCR pipeline with image segmentation, concept formation, and data slicing.

Specifically this repository contains instructions on how to deploy our interface as well as instructions on replicating the evaluation.

Pages

  1. Interface Deployment (here) - for deploying the interface
  2. Custom Detection Results - for creating custom detection results
  3. Evaluation - for setting up evaluation

Datasets

For VCR, we use the MS-COCO dataset found here. For each image dataset, we additionally require the concept data. To make deployment easier we have packaged COCO 2014 validation data here (pw=coco-coco). Please download the data and unzip it accordingly. After extracting, run the following to download COCO 2014 validation directly from the website: cd coco-dataset/imgs && bash download.sh.

Object Detection Results

While we provide COCO 2014 object detection result in the above dataset, users interested in evaluating their own detection results can create their own detection results by following our guide here. If users want to simply visualize the demo, skip the linked guide.

Interface Setup

The interface is implemented in two parts: (1) the frontend and (2) the backend. The frontend is written in Javascript with the React framework, while the backend is implemented in Python with the FastAPI framework.

Mining results from the interface.

Backend

Note

Please make sure to satisfy the following Dependencies: (0) NVIDIA's cuML and Meta's Faiss Library (1) Dataset (2) Object Detection Results (3) Segment Extraction Results

The backend is responsible for concept-formation via clustering, mining concept results, and rendering concept visualizations. Please make sure the dataset, object-detection results, and segment and embedding extraction results are prepared before reaching this point.

Option 1: Install from NVIDIA and Meta Website (Recommended)

  • First, install NVIDIA's cuML library here (recommended). 
    # We found the following worked for us:
conda install -n base conda-libmamba-solver
conda create --solver=libmamba -n rapids-23.12 -c rapidsai -c conda-forge -c nvidia      rapids=23.12 python=3.10 cuda-version=11.8
  • Next, install Meta's Faiss library: 
    conda install -c pytorch -c nvidia faiss-gpu=1.7.4 mkl=2021 blas=1.0=mkl
  • Install dependencies from requirements.txt (make sure this pip is specific to the cuML+Faiss environment): 
    miniconda3/envs/{env_name}/bin/python3 -m pip install -r requirements.txt
  • Where "env_name" is the specific environment housing both Faiss and cuML

Option 2: Install from Conda yml file: This method does not always work and we recommend following the typical steps above.

  • Run conda env create -f environment.yaml

After Option 1/2

  • Modify ROOT_DIR in settings.py to point to the dataset downloaded earlier. Modify port if needed as well.
  • Specify a PORT number and run the backend: PORT=3000 python3 server.py

Frontend

Note

Please make sure to satisfy the following Dependencies: (0) NodeJS, React, and React-Bootstrap

  • Install NodeJS and npm on your system. Follow a tutorial like this one if needed.
  • Ideally, start a new screen or tmux seshion to run the frontend code in the background (e.g. tmux new -s "frontend")
  • CD into the frontend cd interface/frontend
  • Run npm install to install required packages
  • Update the .env file to point to the detection csv (e.g. REACT_APP_BASE_CSV="coco_2014_val.csv") and backend api (if port or address changed)
  • Start running the interface with npm start. This will start the UI on port 3001.