diff --git a/README.md b/README.md index efc8f7e9985c3d3e815726b0e407385a5287f061..00b6ff367bd1c805d1f73b6f1b12928036fa80d8 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ # ExplainDT-Advanced -Based on ExplainDT by Arenas et al. + +Based on [ExplainDT](https://github.com/DiegoEmilio01/A-Symbolic-Language-for-Interpreting-Decision-Trees) by Arenas et al. +Reminder: I do not own this implementation. All the credit goes to Arenas et al. [here](https://github.com/DiegoEmilio01/A-Symbolic-Language-for-Interpreting-Decision-Trees). Bünyamin Dincer has only extended the implementation. Everything that is now mentioned additionally was implemented by Bünyamin Dincer based on the implementation by Arenas et al. + +--- + +To test the implementation yourself, we recommend setting everything up first. To do so, we recommend cloning this repository, and following along the ReadMe [here](https://github.com/DiegoEmilio01/A-Symbolic-Language-for-Interpreting-Decision-Trees). After setting everything up, to find out more about our contribution feel free to come back here to find out more. + +--- + +## Our Contribution +- Added a [GUI](GUI_byBuni.py) for the REPL interpreter allowing the extension of plugins +- Added a special drawing panel for the MNIST dataset for testing purposes +- Prototype query builder plugin added. +- Added second [Mushroom](https://archive.ics.uci.edu/dataset/73/mushroom) dataset for testing purposes. +- Added corresponding [mushroom.py](mushroom.py) implementation +- Updated the REPL Interpreter: If class names have spaces, then one can write "Class A", instead of Class A to prevent errors. Also added generate n command to generate a random instance, and a random partial instance of dimension n + +--- + +To run the GUI for the REPL interpreter simply run the following command on the project's root directory: + +```sh +python3 GUI_byBuni.py +``` + +--- + +The rest of our work is ran in the same way as in the ReadMe [here](https://github.com/DiegoEmilio01/A-Symbolic-Language-for-Interpreting-Decision-Trees).