ripple-down-rules 0.5.3__tar.gz → 0.5.5__tar.gz

{ripple_down_rules-0.5.3 → ripple_down_rules-0.5.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ripple_down_rules
-Version: 0.5.3
+Version: 0.5.5
 Summary: Implements the various versions of Ripple Down Rules (RDR) for knowledge representation and reasoning.
 Author-email: Abdelrhman Bassiouny <abassiou@uni-bremen.de>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -693,7 +693,7 @@ Requires-Dist: colorama
 Requires-Dist: pygments
 Requires-Dist: sqlalchemy
 Requires-Dist: pandas
-Requires-Dist: pyparsing
+Requires-Dist: pyparsing>=3.2.3
 Provides-Extra: viz
 Requires-Dist: networkx>=3.1; extra == "viz"
 Requires-Dist: matplotlib>=3.7.5; extra == "viz"
@@ -725,6 +725,10 @@ For GUI support, also install:
 sudo apt-get install libxcb-cursor-dev
 ```
 
+## Documentation
+
+Read the documentation [here](https://abdelrhmanbassiouny.github.io/ripple_down_rules/).
+
 ## Example Usage
 
 ### Propositional Example
@@ -795,6 +799,19 @@ cat = grdr.classify(all_cases[50])['species']
 assert cat == targets[50]
 ```
 
+When prompted to write a rule, I wrote the following inside the template function that the Ripple Down Rules created:
+```python
+return case.milk == 1
+```
+then
+```python
+return case.aquatic == 1
+```
+
+The rule tree generated from fitting all the dataset will look like this:
+![species_rdr](https://raw.githubusercontent.com/AbdelrhmanBassiouny/ripple_down_rules/main/images/scrdr.png)
+
+
 ### Relational Example
 
 By relational, I mean that each rule conclusion is not a constant value, but is related to the case being classified,
@@ -887,6 +904,6 @@ try that yourself and see if it works!
 author = {Bassiouny, Abdelrhman},
 title = {Ripple-Down-Rules},
 url = {https://github.com/AbdelrhmanBassiouny/ripple_down_rules},
-version = {0.5.2},
+version = {0.5.4},
 }
 ```

{ripple_down_rules-0.5.3 → ripple_down_rules-0.5.5}/README.md

@@ -21,6 +21,10 @@ For GUI support, also install:
 sudo apt-get install libxcb-cursor-dev
 ```
 
+## Documentation
+
+Read the documentation [here](https://abdelrhmanbassiouny.github.io/ripple_down_rules/).
+
 ## Example Usage
 
 ### Propositional Example
@@ -91,6 +95,19 @@ cat = grdr.classify(all_cases[50])['species']
 assert cat == targets[50]
 ```
 
+When prompted to write a rule, I wrote the following inside the template function that the Ripple Down Rules created:
+```python
+return case.milk == 1
+```
+then
+```python
+return case.aquatic == 1
+```
+
+The rule tree generated from fitting all the dataset will look like this:
+![species_rdr](https://raw.githubusercontent.com/AbdelrhmanBassiouny/ripple_down_rules/main/images/scrdr.png)
+
+
 ### Relational Example
 
 By relational, I mean that each rule conclusion is not a constant value, but is related to the case being classified,
@@ -183,6 +200,6 @@ try that yourself and see if it works!
 author = {Bassiouny, Abdelrhman},
 title = {Ripple-Down-Rules},
 url = {https://github.com/AbdelrhmanBassiouny/ripple_down_rules},
-version = {0.5.2},
+version = {0.5.4},
 }
 ```

{ripple_down_rules-0.5.3 → ripple_down_rules-0.5.5}/doc/intro.md

@@ -13,27 +13,39 @@ SCRDR, MCRDR, and GRDR logic were inspired from the book:
 ["Ripple Down Rules: An Alternative to Machine Learning"](https://www.taylorfrancis.com/books/mono/10.1201/9781003126157/ripple-rules-paul-compton-byeong-ho-kang) by Paul Compton, Byeong Ho Kang.
 
 
-Additionally, to the main ripple down rules benefits, this package also features:
-
-- Ontology and Rule base as one entity
-    - Both use same python data structures.
-    - Update in data structures reflects in Rule base.
-    - Both are under one versioning system, the rule base is generated as a python module that becomes part of your
-    project.
-- First, second, and higher order logic is achieved by freely writing python code.
-    - Rule conditions and conclusions are python functions that can do anything that python can do.
-- Automatic maintenance of rule base.
-    - When rules are added contradictions are detected and prompted to the user to add a refinement rule for
-  to resolve the contradiction.
-- Transparent Editable rule base
-    - Rules are understandable python code that can be manually edited and reloaded.
-- Interface that makes coders feel at home by using their favorite IDE.
-- Uses latest technologies like LLMs to help in writing the rules (Inherited feature from IDEs).
-    - Auto completions and suggestions in the IDE.
-    - Ask AI available with the press of a button to help in writing the rule.
-- Rules can be for instances on very specific scenarios and can be very general on super class relations.
-- Accompanied by a GUI with an object explorer panel and an expandable/retractable object diagram to help in
-writing the rules about the object at hand.
+## 🚀 Enhanced Ripple-Down Rules Engine – Key Features
+
+### 🧠 Ontology + Rule Base as One Entity
+- 🧬 Unified data structure: Ontology and rules use the same Python data structures. 
+- 🔄 Automatic sync: Updates to the ontology instantly reflect in the rule base. 
+- 📦 Version controlled: The rule base is a Python module, versioned with your project.
+
+### 🔁 Supports First, Second & Higher-Order Logic
+- 🧩 Unlimited expressiveness: Rule conditions and conclusions are plain Python functions — anything Python can do, your rules can too!
+
+### 🛡️ Automatic Rule Base Maintenance 
+- ⚠️ Contradiction detection: New rules are auto-checked for logical conflicts. 
+- 🔧 Prompted refinements: If a contradiction arises, you're guided to add a refinement rule. 
+
+### 📝 Transparent & Editable Rule Base
+- 📖 Readable rules: Rules are clean, understandable Python code. 
+- 🔄 Reload-friendly: Easily edit and reload rules manually as needed.
+
+### 💻 Developer-Centric Interface
+- 👨‍💻 Feels like home: Seamless integration with your favorite IDE.
+- ✨ Modern coding experience: Auto-completion and suggestions supported via IDE plugins.
+
+### 🤖 LLM-Powered Rule Writing
+- 💡 AI-assisted authoring: Ask AI for help or suggestions directly within the IDE.
+- ⚡ Smart completion: Context-aware completions streamline rule writing.
+
+### 🎯 Flexible Rule Specificity
+- 🧪 Instance-level precision: Write rules for highly specific object scenarios.
+- 🏛️ Generalization-ready: Create broad rules for superclass relationships.
+
+### 🖼️ GUI for Rule Exploration
+- 🧭 Object Explorer Panel: Navigate and inspect objects easily.
+- 🧯 Interactive Diagram: Expandable/collapsible object diagram to guide rule creation visually.
 
 This work aims to provide a flexible and powerful rule-based system that can be used in various applications,
 from simple classification tasks to complex decision-making systems. Furthermore, one of the main goals is to
@@ -51,7 +63,7 @@ performance, so stay tuned for updates! and feel free to contribute, give feedba
 author = {Bassiouny, Abdelrhman},
 title = {Ripple-Down-Rules},
 url = {https://github.com/AbdelrhmanBassiouny/ripple_down_rules},
-version = {0.5.2},
+version = {0.5.4},
 }
 ```
 
@@ -186,6 +198,19 @@ cat = grdr.classify(all_cases[50])['species']
 assert cat == targets[50]
 ```
 
+When prompted to write a rule, I wrote the following inside the template function that the Ripple Down Rules created:
+```python
+return case.milk == 1
+```
+then
+```python
+return case.aquatic == 1
+```
+
+The rule tree generated from fitting all the dataset will look like this:
+![species_rdr](https://raw.githubusercontent.com/AbdelrhmanBassiouny/ripple_down_rules/main/images/scrdr.png)
+
+
 ### Relational Example
 
 By relational, I mean that each rule conclusion is not a constant value, but is related to the case being classified,

ripple_down_rules-0.5.5/images/scrdr.dot

@@ -0,0 +1,127 @@
+digraph tree {
+    "def _get_value(case):
+    return case.milk == 1
+=> def _get_value(case):
+    return Species.mammal";
+    "def _get_value(case):
+    return case.aquatic == 1
+=> def _get_value(case):
+    return Species.fish";
+    "def _get_value(case):
+    return case.feathers == 1
+=> def _get_value(case):
+    return Species.bird";
+    "def _get_value(case):
+    return case.backbone == 0 and case.breathes == 0
+=> def _get_value(case):
+    return Species.molusc";
+    "def _get_value(case):
+    return case.eggs == 1 and case.backbone == 0
+=> def _get_value(case):
+    return Species.insect";
+    "def _get_value(case):
+    return case.backbone == 1 and case.tail == 1
+=> def _get_value(case):
+    return Species.reptile";
+    "def _get_value(case):
+    return case.backbone == 0 and case.eggs == 0
+=> def _get_value(case):
+    return Species.molusc";
+    "def _get_value(case):
+    return case.legs == 0
+=> def _get_value(case):
+    return Species.molusc";
+    "def _get_value(case):
+    return case.fins == 0
+=> def _get_value(case):
+    return Species.molusc";
+    "def _get_value(case):
+    return case.feathers == 1
+=> def _get_value(case):
+    return Species.bird_1";
+    "def _get_value(case):
+    return case.backbone == 1
+=> def _get_value(case):
+    return Species.amphibian";
+    "def _get_value(case):
+    return case.breathes == 0
+=> def _get_value(case):
+    return Species.reptile";
+    "def _get_value(case):
+    return case.milk == 1
+=> def _get_value(case):
+    return Species.mammal" -> "def _get_value(case):
+    return case.aquatic == 1
+=> def _get_value(case):
+    return Species.fish" [style="bold", label=" else if"];
+    "def _get_value(case):
+    return case.aquatic == 1
+=> def _get_value(case):
+    return Species.fish" -> "def _get_value(case):
+    return case.feathers == 1
+=> def _get_value(case):
+    return Species.bird" [style="bold", label=" else if"];
+    "def _get_value(case):
+    return case.aquatic == 1
+=> def _get_value(case):
+    return Species.fish" -> "def _get_value(case):
+    return case.fins == 0
+=> def _get_value(case):
+    return Species.molusc" [style="bold", label=" except if"];
+    "def _get_value(case):
+    return case.feathers == 1
+=> def _get_value(case):
+    return Species.bird" -> "def _get_value(case):
+    return case.backbone == 0 and case.breathes == 0
+=> def _get_value(case):
+    return Species.molusc" [style="bold", label=" else if"];
+    "def _get_value(case):
+    return case.backbone == 0 and case.breathes == 0
+=> def _get_value(case):
+    return Species.molusc" -> "def _get_value(case):
+    return case.eggs == 1 and case.backbone == 0
+=> def _get_value(case):
+    return Species.insect" [style="bold", label=" else if"];
+    "def _get_value(case):
+    return case.eggs == 1 and case.backbone == 0
+=> def _get_value(case):
+    return Species.insect" -> "def _get_value(case):
+    return case.backbone == 1 and case.tail == 1
+=> def _get_value(case):
+    return Species.reptile" [style="bold", label=" else if"];
+    "def _get_value(case):
+    return case.eggs == 1 and case.backbone == 0
+=> def _get_value(case):
+    return Species.insect" -> "def _get_value(case):
+    return case.legs == 0
+=> def _get_value(case):
+    return Species.molusc" [style="bold", label=" except if"];
+    "def _get_value(case):
+    return case.backbone == 1 and case.tail == 1
+=> def _get_value(case):
+    return Species.reptile" -> "def _get_value(case):
+    return case.backbone == 0 and case.eggs == 0
+=> def _get_value(case):
+    return Species.molusc" [style="bold", label=" else if"];
+    "def _get_value(case):
+    return case.fins == 0
+=> def _get_value(case):
+    return Species.molusc" -> "def _get_value(case):
+    return case.feathers == 1
+=> def _get_value(case):
+    return Species.bird_1" [style="bold", label=" except if"];
+    "def _get_value(case):
+    return case.feathers == 1
+=> def _get_value(case):
+    return Species.bird_1" -> "def _get_value(case):
+    return case.backbone == 1
+=> def _get_value(case):
+    return Species.amphibian" [style="bold", label=" else if"];
+    "def _get_value(case):
+    return case.backbone == 1
+=> def _get_value(case):
+    return Species.amphibian" -> "def _get_value(case):
+    return case.breathes == 0
+=> def _get_value(case):
+    return Species.reptile" [style="bold", label=" except if"];
+}

{ripple_down_rules-0.5.3 → ripple_down_rules-0.5.5}/requirements.txt

@@ -10,4 +10,4 @@ colorama
 pygments
 sqlalchemy
 pandas
-pyparsing
+pyparsing>=3.2.3

{ripple_down_rules-0.5.3 → ripple_down_rules-0.5.5}/src/ripple_down_rules/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.5.3"
+__version__ = "0.5.5"
 
 import logging
 logger = logging.Logger("rdr")

{ripple_down_rules-0.5.3 → ripple_down_rules-0.5.5}/src/ripple_down_rules/user_interface/template_file_creator.py

@@ -300,6 +300,7 @@ class TemplateFileCreator:
             if isinstance(node, ast.FunctionDef) and node.name == func_name:
                 exec_globals = {}
                 scope = extract_imports(tree=tree)
+                updates.update(scope)
                 exec(source, scope, exec_globals)
                 user_function = exec_globals[func_name]
                 updates[func_name] = user_function

{ripple_down_rules-0.5.3 → ripple_down_rules-0.5.5}/src/ripple_down_rules/utils.py

@@ -1370,8 +1370,8 @@ def draw_tree(root: Node, fig: Figure):
     """
     Draw the tree using matplotlib and networkx.
     """
-    if matplotlib.get_backend().lower() not in ['qt5agg', 'qt4agg', 'qt6agg']:
-        matplotlib.use("Qt6Agg")  # or "Qt6Agg", depending on availability
+    # if matplotlib.get_backend().lower() not in ['qt5agg', 'qt4agg', 'qt6agg']:
+    #     matplotlib.use("Qt6Agg")  # or "Qt6Agg", depending on availability
 
     if root is None:
         return

{ripple_down_rules-0.5.3 → ripple_down_rules-0.5.5}/src/ripple_down_rules.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ripple_down_rules
-Version: 0.5.3
+Version: 0.5.5
 Summary: Implements the various versions of Ripple Down Rules (RDR) for knowledge representation and reasoning.
 Author-email: Abdelrhman Bassiouny <abassiou@uni-bremen.de>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -693,7 +693,7 @@ Requires-Dist: colorama
 Requires-Dist: pygments
 Requires-Dist: sqlalchemy
 Requires-Dist: pandas
-Requires-Dist: pyparsing
+Requires-Dist: pyparsing>=3.2.3
 Provides-Extra: viz
 Requires-Dist: networkx>=3.1; extra == "viz"
 Requires-Dist: matplotlib>=3.7.5; extra == "viz"
@@ -725,6 +725,10 @@ For GUI support, also install:
 sudo apt-get install libxcb-cursor-dev
 ```
 
+## Documentation
+
+Read the documentation [here](https://abdelrhmanbassiouny.github.io/ripple_down_rules/).
+
 ## Example Usage
 
 ### Propositional Example
@@ -795,6 +799,19 @@ cat = grdr.classify(all_cases[50])['species']
 assert cat == targets[50]
 ```
 
+When prompted to write a rule, I wrote the following inside the template function that the Ripple Down Rules created:
+```python
+return case.milk == 1
+```
+then
+```python
+return case.aquatic == 1
+```
+
+The rule tree generated from fitting all the dataset will look like this:
+![species_rdr](https://raw.githubusercontent.com/AbdelrhmanBassiouny/ripple_down_rules/main/images/scrdr.png)
+
+
 ### Relational Example
 
 By relational, I mean that each rule conclusion is not a constant value, but is related to the case being classified,
@@ -887,6 +904,6 @@ try that yourself and see if it works!
 author = {Bassiouny, Abdelrhman},
 title = {Ripple-Down-Rules},
 url = {https://github.com/AbdelrhmanBassiouny/ripple_down_rules},
-version = {0.5.2},
+version = {0.5.4},
 }
 ```

{ripple_down_rules-0.5.3 → ripple_down_rules-0.5.5}/src/ripple_down_rules.egg-info/SOURCES.txt

@@ -26,6 +26,8 @@ examples/part_containment_rdr/robot_contained_objects_mcrdr.py
 examples/part_containment_rdr/robot_contained_objects_mcrdr_defs.py
 examples/part_containment_rdr/robot_rdr.py
 examples/part_containment_rdr/rdr_metadata/part_containment_rdr.json
+images/scrdr.dot
+images/scrdr.png
 images/thinking_pr2.jpg
 results/complete_mcrdr_extra.dot
 results/complete_mcrdr_extra.png

{ripple_down_rules-0.5.3 → ripple_down_rules-0.5.5}/src/ripple_down_rules.egg-info/requires.txt

@@ -10,7 +10,7 @@ colorama
 pygments
 sqlalchemy
 pandas
-pyparsing
+pyparsing>=3.2.3
 
 [gui]
 pyqt6