clarence-lee-sheng / DetermiNet

DetermiNet

Dataset Description

• Paper: https://arxiv.org/abs/2309.03483
• Site: DetermiNet Site
• Authors:
  • Clarence: [e-mail]
  • Ganesh: [e-mail]
  • Cheston Tan: [e-mail]

Dataset Summary

Determiners are an important word class that is used in the referencing and quantification of nouns. However existing datasets place less emphasis on determiners, compared to other word classes. Hence, we have designed the DetermiNet dataset, which is a visuolinguistic dataset comprising of the word class determiners. It comprises of 25 determiners with 10,000 examples each, totalling 250,000 samples. All scenes were synthetically generated using unity. The task is to predict bounding boxes to identify objects of interest, constrained by the semantics of the determiners

Figure 1. Samples of DetermiNet image-caption pairs, with their bounding box annotations and segmentations

Downloading the files:

Download the files here https://drive.google.com/drive/folders/1J5dleNxWvFUip5RBsTl6OqQBtpWO0r1k?usp=sharing which contains:

• The dataset in the images directory
• COCO annotations and oracle tfrecords directory
• oracle weights
• real DetermiNet dataset

Setting up the files:

• cd into root directory
• extract the images folder from DetermiNet-synth and put it into data/ folder
• extract annotations folder from DetermiNet-synth in root directory
• put oracle_weights in oracle/ folder

+ root 
--+ annotations 
-----+ oracle_tfrecords 
--+ data 
-----+ images 
--+ oracle
-----+ oracle_weights 
.
.
.

Setup

• Setup Unity Hub as per https://docs.unity3d.com/hub/manual/InstallHub.html
• Install Unity Editor 2021.3.9f1
• Install required packages

1. install requirements

pip install -r requirements.txt 
pip install -e .

2. run setup.py

// assume in root directory of the repository 
cd DetermiNetUnity/Assets/utils
python setup_unity_and_clear_files.py

Generating the dataset

Generate your own dataset by referring to the instructions here

Dataset Structure

All data fields are based on the COCO annotation format. Refer to this link for more information: https://cocodataset.org/#home, We add the "input_oracle_annotations" field to provide annotations for all bounding boxes per image to train the neurosymbolic model for DetermiNet.

For all evaluation, metrics was measured in AP @ 0.5:0.95 based on pycocotools

{
    'input_oracle_annotations':[
        {
            "id": ...,
            "image_id": ...,
            "category_id": ...,
            "area": ...,
            "bbox": ...,
            "iscrowd": ...
        }, 
        ...
    ],
    'annotations':[
        {
            "id": ...,
            "image_id": ...,
            "category_id": ...,
            "area": ...,
            "bbox": ...,
            "iscrowd": ...
        }, 
        ...
    ]
}

Retraining the models

Training the Oracle model

python ./oracle/oracle_training.py --image_dir="data/" --tfrecords_dir="annotations/oracle_tfrecords/"

MDETR/OFA

For MDETR and OFA, you may refer to the repositories in the link to run the baseline models.

Evaluation scripts

Evaluating baselines

To reproduce the results we showed in the paper, you can run coco evaluation for mAP based on the jsons we generated in both ground_truths and predictions directories.

You may run the following code to see the evaluation results for our Neurosymbolic model, MDETR and OFA

cd evaluation 
python evaluation_baseline.py 

Evaluating on new models using corrected ground truth

To run on corrected evaluation first save your predictions as specified by the coco format in ./predictions as {model_name}_pred_results.json.

Afterwards, run the evaluation script as below, changing the model_name parameter to your desired name, this script will generate the corrected ground truth file under ground_truths using the model name and evaluate against the predictions in the predictions folder.

cd evaluation 
python evaluate.py --model_name=ns

Real Dataset

Download the real dataset here