FranKGraphBench: Reproducible Benchmarking for Knowledge Graph-based Recommendation
FranKGraphBench is a framework for reproducible benchmarking of Knowledge Graph-based recommender systems. It was first created on Google Summer of Code 2023 for Data Integration between DBpedia and some standard RS datasets in a reproducible framework and was accepted at the Resource Track from the 35th ACM International Conference on Information and Knowledge Management in Rome, Italy from the 7th to 11th November 2026.
Check the docs for more information.
- For more info, check the project proposal and the project progress with weekly (as possible) updates.
Data Integration
pip
We recommend using a python 3.11 virtual environment:
pip install frankgraphbench
Install the full dataset using bash scripts located at datasets/:
cd datasets
bash ml-100k.sh # Downloaded at `datasets/ml-100k` folder
bash ml-1m.sh # Downloaded at `datasets/ml-1m` folder
Source
Install from the repository root using pip install .. We recommend a python 3.11 virtual environment:
python3 -m venv venv_data_integration/
source venv_data_integration/bin/activate
pip install .
To install the exact dependency set manually, use pip install -r requirements.txt.
Install the full dataset using bash scripts located at datasets/:
cd datasets
bash ml-100k.sh # Downloaded at `datasets/ml-100k` folder
bash ml-1m.sh # Downloaded at `datasets/ml-1m` folder
Usage
data_integration [-h] -d DATASET -i INPUT_PATH -o OUTPUT_PATH [-ci] [-cu] [-cr] [-cs] [-map] [-enrich] [-w]
Arguments:
- -h: Shows the help message.
- -d: Name of a supported dataset. It will be the same name of the folder created by the bash script provided for the dataset. For now, check
data_integration/dataset2class.pyto see the supported ones. - -i: Input path where the full dataset is placed.
- -o: Output path where the integrated dataset will be placed.
- -ci: Use this flag if you want to convert item data.
- -cu: Use this flag if you want to convert user data.
- -cr: Use this flag if you want to convert rating data.
- -cs: Use this flag if you want to convert social link data.
- -map: Use this flag if you want to map dataset items with DBpedia. At least the item data should be already converted.
- -enrich: Use this flag if you want to enrich dataset with DBpedia.
- -w: Choose the number of workers(threads) to be used for parallel queries.
pip example:
data_integration -d 'ml-100k' -i 'datasets/ml-100k' -o 'datasets/ml-100k/processed' \
-ci -cu -cr -map -enrich -w 8
source example:
python3 src/data_integration.py -d 'ml-100k' -i 'datasets/ml-100k' -o 'datasets/ml-100k/processed' \
-ci -cu -cr -map -enrich -w 8
Check Makefile for more examples.
Supported datasets
| Dataset | #items matched | #items |
|---|---|---|
| MovieLens-100k | 1411 | 1681 |
| MovieLens-1M | 3253 | 3883 |
| LastFM-hetrec-2011 | 8628 | 17632 |
| Douban-Movie-Short-Comments-Dataset | 24 | 28 |
| MIND-small | 30409 | 51282 |
| Yelp-Dataset | --- | 150348 |
| Amazon-Video-Games-5 | --- | 21106 |
Dataset enrichment, except for the MIND-small dataset, is done through a fixed DBpedia endpoint available at https://dbfk25.aksw.org/sparql, with raw files download available at https://dbfk25.aksw.org/.
Framework for reproducible experiments
pip
We recommend using a python 3.11 virtual environment for all platforms.
pip install frankgraphbench installs the regular tensorflow package on every platform. No manual install is therefore required:
pip install frankgraphbench
If you run into trouble with the automatic install, you can still install manually with the matching requirements file:
pip install -r requirements.txt
source
Install from the repository root using pip install .. We recommend a python 3.11 virtual environment:
python3 -m venv venv_framework/
source venv_framework/bin/activate
pip install .
Usage
pip:
framework -c 'config_files/test.yml'
source:
python3 src/framework.py -c 'config_files/test.yml'
Arguments:
- -c: Experiment configuration file path.
The experiment config file should be a .yaml file like this:
experiment:
dataset:
name: ml-100k
item:
path: datasets/ml-100k/processed/item.csv
extra_features: [movie_year, movie_title]
user:
path: datasets/ml-100k/processed/user.csv
extra_features: [gender, occupation]
ratings:
path: datasets/ml-100k/processed/rating.csv
timestamp: True
enrich:
map_path: datasets/ml-100k/processed/map.csv
enrich_path: datasets/ml-100k/processed/enriched.csv
remove_unmatched: False
properties:
- type: subject
grouped: True
sep: "::"
- type: director
grouped: True
sep: "::"
preprocess:
- method: filter_kcore
parameters:
k: 20
iterations: 1
target: user
split:
seed: 42
test:
method: k_fold
k: 2
level: 'user'
models:
- name: deepwalk_based
config:
save_weights: True
parameters:
walk_len: 10
p: 1.0
q: 1.0
n_walks: 50
embedding_size: 64
epochs: 1
evaluation:
k: 5
relevance_threshold: 3
metrics: [MAP, nDCG]
report:
file: 'experiment_results/ml100k_enriched/run1.csv'
See the config_files/ directory for more examples.
Supported Pre-processing Methods
Those are the currently supported pre-processing methods:
- Binarize ratings.
- Filtering by k-core
Supported Splitting Methods
Currently the supported Splitting methods are:
- Random by Ratio
- Timestamp by Ratio
- Fixed Timestamp
- K-Fold
Supported Evaluation Metrics
Those are the already implemented metrics:
- MAP@k
- nDCG@k
- Precision@k
- Recall@k
- F-score@k
Chart generation
Chart generation module based on: https://github.com/hfawaz/cd-diagram
pip
We recommend using a python 3.11 virtual environment
pip install frankgraphbench
source
Install from the repository root using pip install .. We recommend a python 3.11 virtual environment:
python3 -m venv venv_chart_generation/
source venv_chart_generation/bin/activate
pip install .
After obtaining results from some experiments, you can use this module to generate charts for them. The module is based on the CD-Diagram, which is a chart to compare multiple methods across multiple datasets and metrics. It is based on the Critical Difference diagram, but with some modifications to allow it to be more informative and easier to read.
Usage
pip:
chart_generation [-h] -c CHART -p PERFORMANCE_METRIC -f INPUT_FILES -i INPUT_PATH -o OUTPUT_PATH -n FILE_NAME
source:
python3 src/chart_generation.py [-h] -c CHART -p PERFORMANCE_METRIC -f INPUT_FILES -i INPUT_PATH -o OUTPUT_PATH -n FILE_NAME
Arguments:
- -h: Shows the help message.
- -p: Name of the performance metric within the file to use for chart generation.
- -f: List of .csv files to use for generating the chart.
- -i: Path where results data to generate chart is located in .csv files.
- -o: Path where generated charts will be placed.
- -n: Add a name (and file extension) to the chart that will be generated.
Examples:
pip:
chart_generation -c 'cd-diagram' -p 'MAP@5' -f "['ml-100k.csv', 'ml-1m.csv', 'lastfm.csv', 'ml-100k_enriched.csv', 'ml-1m_enriched.csv', 'lastfm_enriched.csv']" -i 'experiment_results' -o 'charts' -n 'MAP@5.pdf'
source:
python3 src/chart_generation.py -c 'cd-diagram' -p 'MAP@5' -f "['ml-100k.csv', 'ml-1m.csv', 'lastfm.csv', 'ml-100k_enriched.csv', 'ml-1m_enriched.csv', 'lastfm_enriched.csv']" -i 'experiment_results' -o 'charts' -n 'MAP@5.pdf'
Supported charts
| Chart |
|---|
| CD-Diagram |
Metadata
Release files for FranKGraphBench 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| frankgraphbench-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Release files / frankgraphbench-0.2.0-py3-none-any.whl
| Download URL | frankgraphbench-0.2.0-py3-none-any.whl |
|---|---|
| Size | 207.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
00301532940b340064de87d491202bd4041eb408cf8ed3e293c752b4b7afd835
|
|
BLAKE2b-256 checksum How to use checksums |
f59efb79436ac8787f989d3896ea68649f4bf7eaa59fb77ecf2a9d25889121d7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.7
|