Skip to content

Latest commit

 

History

History
157 lines (98 loc) · 5.67 KB

README.md

File metadata and controls

157 lines (98 loc) · 5.67 KB
Raw

Neuro-symbolic Rule Learning with Neural DNF-based Models in CUB dataset/subsets

This repository contains the source code for multi-class classification experiments in CUB[1] dataset/subsets, accompanied the paper "Neuro-symbolic Rule Learning in Real-world Classification Tasks". Our neural DNF-based models are built upon pix2rule[2]'s semi-symbolic layers.

Check out sibling repo: Neuro-symbolic rule learning with neural DNF models in TMC dataset/subsets

Project structure

Directories

  • conf/: contains hydra config for running experiments.

  • scripts/: some useful bash scripts for running data pre-processing and generating FastLAS[3] examples. The scripts rely their corresponding python scripts described below.

  • synthetic_test: contains the synthetic binary and multi-class classification tasks, as well as a unit test for our implementation of semi-symbolic layers.

Modules

  • analysis.py: contains various Meter classes for different metrics.

  • common.py, dataset.py, and utils.py: common reusable classes/functions for experiments.

  • dnf_layer.py: implementation of pix2rule's semi-symbolic layer.

  • dnf_post_train.py: post-training processes for symbolic rule extraction.

  • eval.py: evaluation methods for neural DNF-EO and ASP rules.

  • rule_learner.py: the full neural DNF-EO model.

  • train.py: contains the base Trainer class for training a neural DNF-based model.

Python scripts

  • data_preprocess.py: data pre-processing script for CUB dataset, also used for generating subsets. We follow the same pre-processing used in Concept Bottleneck Models paper [4].

  • full_pipeline_dnf.py: full pipeline of training a neural DNF-EO model and post-training processing.

  • las_gen.py: script for generating FastLAS learning example and mode biases.

  • mlp_baseline.py: full pipeline of training and evaluation of MLP.

  • run_train.py: training process of a neural DNF-EO model.

Models

Our neural DNF-based models are created with pix2rule's semi-symbolic layers.

The vanilla neural DNF model is identical to pix2rule, but does not enforce mutual exclusivity (i.e. predicting exactly one class at a time).

vanilla neural DNF

One of our contributions in the paper is the neural DNF-EO model (in rule_learner.py), which enforces mutual exclusivity with the constraint layer. The constraint layer mimics the logic formula $class_i \leftarrow \wedge_{j, j\neq i}\ class_j$ which states that a class can only be true if all other classes are not true. This constraint layer is not trainable, and at inference time we remove it and only use the plain neural DNF to make predictions.

neural dnf eo

Requirements

Base python version: >= 3.10

Dataset: Caltech-UCSD Birds-200-2011 - download: link (this link may not be working any more)

Python libraries:

  • Pytorch version >= 1.12.0 - machine learning framework

    • Torchvision - computer vision library. Not used for the rule learning from CUB attributes, but left in the code for potential end-to-end learning from CUB images.

  • Hydra version >= 1.2 - config management framework

  • Clingo - ASP solver

  • scikit-learn - metrics & decision tree

Optional requirements:

  • FastLAS - for symbolic learning from ASP. Our neural DNF-EO model does not require FastLAS.

Running instructions

Data pre-processing

To reproduce our experiments, you will first need to pre-process the data and create CUB subsets. Go to scripts/ and we have more instructions there.

Neural DNF-EO model

To run the full training pipeline for neural DNF-EO model, edit the configs in conf/ (for more information on how to manage hydra config, refer to their documentation). We create a dnf_eo_example.yaml in conf/training/ for example setup.

In particular, the important yaml files need to be edited are:

  • conf/model/config.yaml: for changing model architectural design.

  • conf/training/dnf_eo.yaml: training config for the neural DNF-EO experiment.

  • conf/environment/[name].yaml: paths for the pkl files.

Once you setup the configs, you can run the following command:

python full_pipeline_dnf.py [hydra config overwrites]

MLP

To run the training pipeline for MLP baseline, edit the training configs in the mlp_baseline.py script, and you still need conf/environment/ set up. Once ready, run the following command:

python mlp_baseline.py [hydra config overwrites]

FastLAS

You will need to install FastLAS and clingo first. Once you have them installed, got to scripts/ and we have further instructions for generating FastLAS learning tasks and running.

References

[1] Catherine Wah et al., The Caltech-UCSD Birds-200-2011 Dataset

[2] Nuri Cingillioglu et al., pix2rule: End-to-end Neuro-symbolic Rule Learning.

[3] Mark Law et al., FastLAS: Scalable Inductive Logic Programming Incorporating Domain-Specific Optimisation Criteria

[4] Pang Wei Koh, Thao Nguyen, Yew Siang Tang et al., Concept Bottleneck Models