An Inductive Logic Programming framework for classifying chemical compounds into ChEBI classes.
Project description
chebILP
An Inductive Logic Programming (ILP) framework for classifying chemical compounds into ChEBI classes. Rules are learned with Popper and evaluated with Clingo (Answer Set Programming).
Installation
Prerequesites
SWI-Prolog must be installed and on PATH (required by Popper).
Popper must be installed as well. You can either install the latest version of Popper with
pip install https://github.com/logic-and-learning-lab/Popper
or a forked, slightly outdated version with
pip install https://github.com/sfluegel05/Popper
With the latter, you can use the --mdl_weight_fn, --mdl_weight_fp and --mdl_weight_seize options of the learn command.
Core package
pip install chebILP
Extras:
pip install chebILP[explain]addsxclingoandPillowfor theexplaincommandpip install chebILP[llm]addsanthropic,langsmith, andpython-dotenvfor LLM-enhanced rule learning (enhance_with_llms, experimental)
The prepare_dl_preds utility (one-time DL tensor extraction) additionally requires torch, which must be installed separately in an environment that has the DL model checkpoint.
Usage
To get a list of available commands, run
python -m chebILP -h
To get help for a specific command, run
python -m chebILP {command} -h
Workflows
1. Generating new data
An ILP dataset for ChEBI version 248 is available on HuggingFace. However, you can also create your own dataset.
Step 1 — Download ChEBI data and build the dataset (downloads chebi.obo and chebi.sdf.gz, builds cached graph and molecule files, selects label classes, and creates a train/val/test split):
python -m chebILP prepare_dataset \
--chebi_version 248 \
--min_pos_samples 25
This writes to data/chebi_v248/:
chebi_graph.pkl— hierarchy graph (networkx DiGraph)molecules.pkl— molecule DataFrame (index = ChEBI ID)min50/labels.txt— selected class IDs (one per line)min50/splits.csv— molecule-level train/val/test split
Step 2 — Build ILP example files (positive/negative molecules per class):
python -m chebILP build_samples \
--labels_file data/chebi_v248/ChEBI25_3_STAR/labels.txt \
--chebi_split data/chebi_v248/ChEBI25_3_STAR/splits.csv \
--chebi_graph_path data/chebi_v248/chebi_graph.pkl \
--molecules_path data/chebi_v248/ChEBI25_3_STAR/molecules.pkl
Step 3 — Build ILP background knowledge files (molecule features as logic facts):
python -m chebILP build_bk \
--labels_file data/chebi_v248/ChEBI25_3_STAR/labels.txt \
--chebi_split data/chebi_v248/ChEBI25_3_STAR/splits.csv \
--chebi_graph_path data/chebi_v248/chebi_graph.pkl \
--molecules_path data/chebi_v28/ChEBI25_3_STAR/molecules.pkl
Steps 2 and 3 write files into data/ilp_problems/ (one subdirectory per class). Available predicate sets: atoms, chembl_fgs, chebi_fgs, chebi_fg_rules and chebi_fg_learned_rules.
2. Learning ILP rules
Learn Prolog classification rules for each class using the examples and background knowledge from workflow 1.
The learn function will create an updated bias file based on the max_vars, max_body and max_clauses parameters.
Learn rules:
python -m chebILP learn \
--labels_file data/chebi_v248/ChEBI25_3_STAR/labels.txt \
--chebi_split data/chebi_v248/ChEBI25_3_STAR/splits.csv \
--timeout 60
Output is written to a timestamped directory data/results/run_YYYYMMDD_HHMMSS/ containing results.json (one entry per class with the learned program and training score) and config.yml.
Evaluate on test/validation set:
python -m chebILP test \
--run_to_evaluate data/results/run_20260101_120000 \
--test_on test
Optional: LLM-enhanced rules (experimental)
To improve learned programs with an LLM (requires ANTHROPIC_API_KEY in .env):
python -m chebILP.enhance_with_llms \
--input data/ilp_programs.csv \
--output data/enhanced_run \
--chebi_version 248
Input CSV must have columns chebi_id, program, run_name. The output directory is readable by the test command.
3. Building an ensemble (ILP + DL)
Combine ILP rules with a deep learning (DL) model for hierarchical multi-label classification. The ensemble uses DL predictions for non-leaf classes and selects either ILP or DL for each leaf class based on validation F1.
Step 1 — Build full ILP prediction tensors (run once per ILP run, for the validation and/or test split):
python -m chebILP build_ilp_preds_for_ensemble \
--run_dir data/results_val/run_20260101_120000 \
--predict_on validation \
--chebi_split data/chebi_v248/ChEBI25_3_STAR/processed/splits.csv \
--chebi_version 248
This writes full_val_preds.npy and full_val_preds_metadata.json into the run directory. Repeat with --predict_on test for the test split.
Step 2 — Model selection and ILP tensor assembly:
python -m chebILP ensemble_construct \
--chebi_split data/chebi_v248/ChEBI25_3_STAR/processed/splits.csv \
--dl_val_preds_npy data/preds/val_preds.npy \
--dl_val_preds_meta data/preds/val_preds_metadata.json \
--ilp_val_runs data/results_val/run_A data/results_val/run_B \
--label_stats data/chebi_v248/ChEBI25_3_STAR/processed/class_stats.csv \
--predict_on test \
--output data/ensemble_predictions/ensemble
For each leaf class, selects the ILP run whose ensemble F1 (ILP prediction AND all DL parent predictions >= 0.5) is highest; falls back to DL if no ILP run beats it. Outputs:
ensemble_trusted_models.csv— which model is used per classensemble_ilp_preds.npy+ensemble_ilp_preds_metadata.json— ILP tensor for the target split
Step 3 — Aggregate into final predictions:
python -m chebILP ensemble_aggregate \
--dl_preds_npy data/preds/test_preds.npy \
--dl_preds_meta data/preds/test_preds_metadata.json \
--ilp_preds_npy data/ensemble_predictions/ensemble_ilp_preds.npy \
--ilp_preds_meta data/ensemble_predictions/ensemble_ilp_preds_metadata.json \
--trusted_models data/ensemble_predictions/ensemble_trusted_models.csv \
--label_stats data/chebi_v248/ChEBI25_3_STAR/processed/class_stats.csv \
--output data/ensemble_predictions/final_predictions.npy
DL predictions propagate freely through the class hierarchy; ILP and always-positive classes only predict a class if all label-set parents are already predicted positive. Output is a boolean NumPy array with a matching _metadata.json.
Other utilities
Translate a rule to natural language (global explanation):
python -m chebILP rule_to_nl --rule "chebi_15734(V0) :- has_atom(V0,V1), c(V1), has_2_hs(V1), bSINGLE(V1,V2), o(V2), has_1_hs(V2)." --chebi_graph_path data/chebi_v248/chebi_graph.pkl
Explain why a molecule satisfies a rule (local explanation):
python -m chebILP explain \
--smiles "CCO" \
--rule "chebi_15734(V0) :- has_atom(V0,V1), c(V1), has_2_hs(V1), bSINGLE(V1,V2), o(V2), has_1_hs(V2)." \
--chebi_graph_path data/chebi_v248/chebi_graph.pkl \
--output explanation.png
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file chebilp-1.0.1.tar.gz.
File metadata
- Download URL: chebilp-1.0.1.tar.gz
- Upload date:
- Size: 51.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8ac9b0dff5269740e7e2f945bb3781a864c03ed94080c9058469054d300b87fb
|
|
| MD5 |
1533225498c457c9426cf293246a72b1
|
|
| BLAKE2b-256 |
2ff0cd51f7a9ce41aba4548a58e0b4c442aa9fb03d015d2814f674f1cd30fb0b
|
Provenance
The following attestation bundles were made for chebilp-1.0.1.tar.gz:
Publisher:
python-publish.yml on ChEB-AI/chebILP
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
chebilp-1.0.1.tar.gz -
Subject digest:
8ac9b0dff5269740e7e2f945bb3781a864c03ed94080c9058469054d300b87fb - Sigstore transparency entry: 1644115065
- Sigstore integration time:
-
Permalink:
ChEB-AI/chebILP@71e809f650d2c43945779dba29810b09deeaab90 -
Branch / Tag:
refs/tags/v1.0.1 - Owner: https://github.com/ChEB-AI
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@71e809f650d2c43945779dba29810b09deeaab90 -
Trigger Event:
release
-
Statement type:
File details
Details for the file chebilp-1.0.1-py3-none-any.whl.
File metadata
- Download URL: chebilp-1.0.1-py3-none-any.whl
- Upload date:
- Size: 56.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f5b9d0d41a318f06b4d9c3ce26868b9aa4866686b94a9c993c097d247c93a5fc
|
|
| MD5 |
8e4ffc7eec4f4f2fc2ce36d753ce00f1
|
|
| BLAKE2b-256 |
5c1b47c9dd7e41a2edfdda7e13da77c5ac3a1af575c004de04328d9a2aa86f58
|
Provenance
The following attestation bundles were made for chebilp-1.0.1-py3-none-any.whl:
Publisher:
python-publish.yml on ChEB-AI/chebILP
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
chebilp-1.0.1-py3-none-any.whl -
Subject digest:
f5b9d0d41a318f06b4d9c3ce26868b9aa4866686b94a9c993c097d247c93a5fc - Sigstore transparency entry: 1644115154
- Sigstore integration time:
-
Permalink:
ChEB-AI/chebILP@71e809f650d2c43945779dba29810b09deeaab90 -
Branch / Tag:
refs/tags/v1.0.1 - Owner: https://github.com/ChEB-AI
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@71e809f650d2c43945779dba29810b09deeaab90 -
Trigger Event:
release
-
Statement type: