These are the experimental data for the paper
Bach, Jakob. "Using Constraints to Discover Sparse and Alternative Subgroup Descriptions"
published on arXiv in 2024.
You can find the paper here and the code here.
See the README
for details.
The datasets used in our study (which we also provide here) originate from PMLB.
The corresponding GitHub repository is MIT-licensed ((c) 2016 Epistasis Lab at UPenn).
Please see the file LICENSE
in the folder datasets/
for the license text.
Experimental Data for the Paper "Using Constraints to Discover Sparse and Alternative Subgroup Descriptions"
These are the experimental data for the paper
Bach, Jakob. "Using Constraints to Discover Sparse and Alternative Subgroup Descriptions"
published at arXiv in 2024.
If we create further versions of this paper in the future, these experimental data may cover them as well.
Check our GitHub repository for the code and instructions to reproduce the experiments.
We obtained the experimental results on a server with an AMD EPYC 7551
CPU (32 physical cores, base clock of 2.0 GHz) and 160 GB RAM.
The operating system was Ubuntu 20.04.6 LTS
.
The Python version was 3.8
.
With this configuration, running the experimental pipeline (run_experiments.py
) took about 34 hours.
The commit hash for the last run of the experimental pipeline (run_experiments.py
) is 0a57bcd529.
The commit hash for the last run of the evaluation pipeline (run_evaluation_arxiv.py
) is 48f2465b4c.
We also tagged both commits (run-2024-05-13
and evaluation-2024-05-15
).
The experimental data are stored in two folders, datasets/
and results/
.
Further, the console output of run_evaluation_arxiv.py
is stored in Evaluation_console_output.txt
(manually copied from the console to a file).
In the following, we describe the structure and content of each data file.
datasets/
These are the input data for the experimental pipeline run_experiments.py
, i.e., the prediction datasets.
The folder contains one overview file, one license file, and two files for each of the 27 datasets.
The original datasets were downloaded from PMLB with the script prepare_datasets.py
.
Note that we do not own the copyright for these datasets.
However, the GitHub repository of PMLB, which stores the original datasets, is MIT-licensed ((c) 2016 Epistasis Lab at UPenn).
Thus, we include the file LICENSE
from that repository.
After downloading from PMLB
, we split each dataset into the feature part (_X.csv
) and the target part (_y.csv
), which we save separately.
Both file types are CSVs that only contain numeric values (categorical features are ordinally encoded in PMLB
) except for the column names.
There are no missing values.
Each row corresponds to a data object (= instance, sample), and each column either corresponds to a feature (in _X
) or the target (in _y
).
The first line in each _X
file contains the names of the features as strings; for _y
files, there is only one column, always named target
.
For the prediction target, we ensured that the minority (i.e., less frequent) class is the positive class (i.e., has the class label 1
), so the labeling may differ from PMLB.
_dataset_overview.csv
contains meta-data for the datasets, like the number of instances and features.
results/
These are the output data of the experimental pipeline in the form of CSVs, produced by the script run_experiments.py
.
_results.csv
contains all results merged into one file and acts as input for the script run_evaluation_arxiv.py
.
The remaining files are subsets of the results, as the experimental pipeline parallelizes over 27 datasets, 5 cross-validation folds, and 6 subgroup-discovery methods.
Thus, there are 27 * 5 * 6 = 810
files containing subsets of the results.
Each row in a result file corresponds to one subgroup.
One can identify individual subgroup-discovery runs with a combination of multiple columns, i.e.:
- dataset
dataset_name
- cross-validation fold
split_idx
- subgroup-discovery method
sd_name
- feature-cardinality threshold
param.k
(missing value if no feature-cardinality constraint)
- solver timeout
param.timeout
(missing value if not solver-based search)
- number of alternatives
param.a
(missing value if only original subgroup searched)
- dissimilarity threshold
param.tau_abs
(missing value if only original subgroup searched)
For each value combination of these seven columns, there is either one subgroup (search for original subgroups)
or six subgroups (search for alternative subgroup descriptions, in which case the column alt.number
identifies individual subgroups within a search run).
Further, note that the last four mentioned columns contain missing values, which should be treated as a category on their own.
In particular, if you use groupby()
from pandas
for analyzing the results and you want to include any of the last four mentioned columns in the grouping,
you should either fill in the missing values with an (arbitrary) placeholder value or use dropna=False
,
because the grouping (by default) ignores the rows with missing values in the group columns otherwise.
The remaining columns represent results and evaluation metrics.
In detail, all result files contain the following columns:
objective_value
(float in [-0.25, 1]
+ missing values): Objective value of the subgroup-discovery method on the training set.
WRAcc when searching original subgroups and normalized Hamming similarity when searching alternative subgroup descriptions.
Missing value for MORS as the subgroup-discovery method, since MORS does not explicitly compute an objective when searching for subgroups.
optimization_status
(string, 2 different values + missing values): For SMT, sat
if optimal solution found and unknown
if timeout.
Missing value for all other subgroup-discovery methods (which do not use solver timeouts).
optimization_time
(non-negative float): The runtime of optimization in the subgroup-discovery method, i.e., without pre- and post-processing steps.
fitting_time
(non-negative float): The complete runtime of the subgroup-discovery method (as reported in the paper), i.e., including pre- and post-processing steps.
Very similar to optimization_time
except for SMT as the subgroup-discovery method, which may spend a considerable amount of time formulating the optimization problem.
train_wracc
(float in [-0.25, 0.25]
): The weighted relative accuracy (WRAcc) of the subgroup description on the training set.
test_wracc
(float in [-0.25, 0.25]
): The weighted relative accuracy (WRAcc) of the subgroup description on the test set.
train_nwracc
(float in [-1, 1]
): The normalized weighted relative accuracy (WRAcc divided by its dataset-dependent maximum) of the subgroup description on the training set.
test_nwracc
(float in [-1, 1]
): The normalized weighted relative accuracy (WRAcc divided by its dataset-dependent maximum) of the subgroup description on the test set.
box_lbs
(list of floats, e.g., [-inf, 0, -inf, -2, 8]
): The lower bounds for each feature in the subgroup description.
Negative infinity if a feature's lower bound did not exclude any data objects from the subgroup.
box_ubs
(list of floats, e.g., [inf, 10, inf, 5, 9]
): The upper bounds for each feature in the subgroup description.
Positive infinity if a feature's upper bound did not exclude any data objects from the subgroup.
selected_feature_idxs
(list of non-negative ints, e.g., [0, 4, 5]
): The indices (starting from 0) of the features selected (= restricted) in the subgroup description.
Is an empty list, i.e., []
, if no feature was restricted (thus, the subgroup contains all data objects).
dataset_name
(string, 27 different values): The name of the PMLB
dataset used for subgroup discovery.
split_idx
(int in [0, 4]
): The index of the cross-validation fold of the dataset used for subgroup discovery.
sd_name
(string, 6 different values): The name of the subgroup-discovery method (Beam
, BI
, MORS
, PRIM
, Random
, or SMT
).
param.k
(int in [1, 5]
+ missing values): The feature-cardinality threshold for subgroup descriptions.
Missing value if unconstrained subgroup discovery.
Always 3
if alternative subgroup descriptions searched.
param.timeout
(int in [1, 2048]
+ missing values): For SMT, solver timeout (in seconds) for optimization (not including formulation of the optimization problem).
Missing value for all other subgroup-discovery methods.
alt.hamming
(float in [0, 1]
+ missing values): Normalized Hamming similarity between the current subgroup (original or alternative) and the original subgroup if alternative subgroup descriptions searched.
Missing value if only original subgroup searched.
alt.jaccard
(float in [0, 1]
+ missing values): Jaccard similarity between the current subgroup (original or alternative) and the original subgroup if alternative subgroup descriptions searched.
Missing value if only original subgroup searched.
alt.number
(int in [0, 5]
+ missing values): The number of the current alternative if alternative subgroup descriptions searched.
Missing value if only original subgroup searched.
Thus, original subgroups either have 0
or a missing value in this column (i.e., for experimental settings where alternative subgroup descriptions searched, there is no separate search for an original subgroup, only a joint sequential search for original and alternatives).
param.a
(int with value 5
+ missing values): The number of desired alternative subgroup descriptions, not counting the original (zeroth) subgroup description.
Missing value if only original subgroup searched.
param.tau_abs
(int in [1, 3]
+ missing values) The dissimilarity threshold for alternatives, corresponding to the absolute number of features that have to be deselected from the original subgroup description and each prior alternative.
Missing value if only original subgroup searched.
You can easily read in any of the result files with pandas
:
```python
import pandas as pd
results = pd.read_csv('results/_results.csv')
```
All result files are comma-separated and contain plain numbers and unquoted strings, apart from the columns box_lbs
, box_ubs
, and selected_feature_idxs
(which represents lists and whose values are quoted except for empty lists).
The first line in each result file contains the column names.
You can use the following code to make sure that the lists of feature indices are treated as such (rather than strings):
```python
import ast
results['selected_feature_idxs'] = results['selected_feature_idxs'].apply(ast.literal_eval)
```
Note that this conversion does not work for box_lbs
and box_ubs
, where the lists not only contain ordinary numbers but also -inf
, and inf
;
see this Stack Overflow post for potential alternatives.