JSON Configuration Files¶

Configuration files are meant to ease the use of our algorithms. It allows you to write all needed arguments inside a JSON formatted file and use it as input to any dimlpfidex algorithm. This will allow you to write shorter Python function calls and/or CLI commands, improving readability and reusability.

./fidex --root_folder my/folder/ --train_data_file train_data.txt --train_pred_file train_predictions.out --train_class_file train_classes.txt --test_data_file test_data.txt --nb_attributes 16 --nb_classes 2 --weights_file weights.wts --rules_outfile output_rules.rls --stats_file output_stats.txt

./fidex --json_config_file my_conf.json

from dimlpfidex.fidex import fidex

fidex(
"""--root_folder my/folder/ 
    --train_data_file train_data.txt 
    --train_pred_file train_predictions.out 
    --train_class_file train_classes.txt 
    --test_data_file test_data.txt 
    --nb_attributes 16 
    --nb_classes 2 
    --weights_file weights.wts 
    --rules_outfile output_rules.rls 
    --stats_file output_stats.txt"""
)

from dimlpfidex.fidex import fidex
fidex("""--json_config_file my_conf.json""")

If you are not used to JSON, you can:

• learn more about JSON here and try it by yourself.
• use our graphical user interface and generate your configuration file easily.

Example¶

Here is a simple example of the content of a configuration file named my_conf.json, this one respects the comparison above.

{
    "root_folder": "my/folder/",
    "train_data_file": "train_data.txt",
    "train_pred_file": "train_predictions.out", 
    "train_class_file": "train_classes.txt ",
    "test_data_file": "test_data.txt ",
    "nb_attributes": 16,
    "nb_classes": 2,
    "weights_file": "weights.wts ",
    "rules_outfile": "output_rules.rls",
    "stats_file": "output_stats.txt"
}