ripple-down-rules 0.4.2__py3-none-any.whl → 0.4.3__py3-none-any.whl

ripple_down_rules/rdr.py

@@ -16,9 +16,10 @@ from .datastructures.callable_expression import CallableExpression
 from .datastructures.case import Case, CaseAttribute, create_case
 from .datastructures.dataclasses import CaseQuery
 from .datastructures.enums import MCRDRMode
-from .experts import Expert
+from .experts import Expert, Human
 from .helpers import is_matching
 from .rules import Rule, SingleClassRule, MultiClassTopRule, MultiClassStopRule
+from .user_interface.gui import RDRCaseViewer
 from .utils import draw_tree, make_set, copy_case, \
     SubclassJSONSerializer, make_list, get_type_from_string, \
     is_conflicting, update_case, get_imports_from_scope, extract_function_source
@@ -41,12 +42,25 @@ class RippleDownRules(SubclassJSONSerializer, ABC):
     The name of the generated python file.
     """
 
-    def __init__(self, start_rule: Optional[Rule] = None):
+    def __init__(self, start_rule: Optional[Rule] = None, viewer: Optional[RDRCaseViewer] = None):
         """
         :param start_rule: The starting rule for the classifier.
         """
         self.start_rule = start_rule
         self.fig: Optional[plt.Figure] = None
+        self.viewer: Optional[RDRCaseViewer] = viewer
+        if self.viewer is not None:
+            self.viewer.set_save_function(self.save)
+
+    def set_viewer(self, viewer: RDRCaseViewer):
+        """
+        Set the viewer for the classifier.
+
+        :param viewer: The viewer to set.
+        """
+        self.viewer = viewer
+        if self.viewer is not None:
+            self.viewer.set_save_function(self.save)
 
     def fit(self, case_queries: List[CaseQuery],
             expert: Optional[Expert] = None,
@@ -703,7 +717,8 @@ class GeneralRDR(RippleDownRules):
      gets called when the final rule fires.
     """
 
-    def __init__(self, category_rdr_map: Optional[Dict[str, Union[SingleClassRDR, MultiClassRDR]]] = None):
+    def __init__(self, category_rdr_map: Optional[Dict[str, Union[SingleClassRDR, MultiClassRDR]]] = None,
+                 **kwargs):
         """
         :param category_rdr_map: A map of case attribute names to ripple down rules classifiers,
         where each category is a parent category that has a set of mutually exclusive (in case of SCRDR) child
@@ -715,7 +730,7 @@ class GeneralRDR(RippleDownRules):
         """
         self.start_rules_dict: Dict[str, Union[SingleClassRDR, MultiClassRDR]] \
             = category_rdr_map if category_rdr_map else {}
-        super(GeneralRDR, self).__init__()
+        super(GeneralRDR, self).__init__(**kwargs)
         self.all_figs: List[plt.Figure] = [sr.fig for sr in self.start_rules_dict.values()]
 
     def add_rdr(self, rdr: Union[SingleClassRDR, MultiClassRDR], attribute_name: Optional[str] = None):

ripple_down_rules/user_interface/gui.py

@@ -12,7 +12,7 @@ from PyQt6.QtWidgets import (
 )
 from qtconsole.inprocess import QtInProcessKernelManager
 from qtconsole.rich_jupyter_widget import RichJupyterWidget
-from typing_extensions import Optional, Any, List, Dict
+from typing_extensions import Optional, Any, List, Dict, Callable
 
 from ..datastructures.dataclasses import CaseQuery
 from ..datastructures.enums import PromptFor
@@ -275,9 +275,13 @@ class RDRCaseViewer(QMainWindow):
     main_obj: Optional[Dict[str, Any]] = None
     user_input: Optional[str] = None
     attributes_widget: Optional[QWidget] = None
+    save_function: Optional[Callable[str], None] = None
 
-    def __init__(self, parent=None):
+
+    def __init__(self, parent=None, save_file: Optional[str] = None):
         super().__init__(parent)
+        self.save_file = save_file
+
         self.setWindowTitle("RDR Case Viewer")
 
         self.setBaseSize(1600, 600)  # or your preferred initial size
@@ -316,6 +320,15 @@ class RDRCaseViewer(QMainWindow):
         main_layout.addWidget(middle_widget, stretch=2)
         main_layout.addWidget(self.obj_diagram_viewer, stretch=2)
 
+    def set_save_function(self, save_function: Callable[[str], None]) -> None:
+        """
+        Set the function to save the file.
+
+        :param save_function: The function to save the file.
+        """
+        self.save_function = save_function
+        self.save_btn.clicked.connect(lambda: self.save_function(self.save_file))
+
     def print(self, msg):
         """
         Print a message to the console.
@@ -406,9 +419,9 @@ class RDRCaseViewer(QMainWindow):
                 self.expand_collapse_all(item.widget(), expand=False)
 
     def expand_collapse_all(self, widget, expand=True, curr_depth=0, max_depth=2):
-        widget.toggle_button.setChecked(expand)
-        widget.toggle()
         if expand and curr_depth < max_depth:
+            widget.toggle_button.setChecked(expand)
+            widget.toggle()
             # do it for recursive children
             for i in range(widget.content_layout.count()):
                 item = widget.content_layout.itemAt(i)
@@ -419,7 +432,14 @@ class RDRCaseViewer(QMainWindow):
 
     def create_buttons_widget(self):
         button_widget = QWidget()
-        button_widget_layout = QHBoxLayout(button_widget)
+        button_widget_layout = QVBoxLayout(button_widget)
+
+        row_1_button_widget = QWidget()
+        row_1_button_widget_layout = QHBoxLayout(row_1_button_widget)
+        row_2_button_widget = QWidget()
+        row_2_button_widget_layout = QHBoxLayout(row_2_button_widget)
+        button_widget_layout.addWidget(row_1_button_widget)
+        button_widget_layout.addWidget(row_2_button_widget)
 
         accept_btn = QPushButton("Accept")
         accept_btn.clicked.connect(self._accept)
@@ -433,9 +453,13 @@ class RDRCaseViewer(QMainWindow):
         load_btn.clicked.connect(self._load)
         load_btn.setStyleSheet(f"background-color: {color_name_to_html('b')}; color: white;")  # Blue button
 
-        button_widget_layout.addWidget(accept_btn)
-        button_widget_layout.addWidget(edit_btn)
-        button_widget_layout.addWidget(load_btn)
+        self.save_btn = QPushButton("Save")
+        self.save_btn.setStyleSheet(f"background-color: {color_name_to_html('b')}; color: white;")  # Blue button
+
+        row_1_button_widget_layout.addWidget(edit_btn)
+        row_1_button_widget_layout.addWidget(load_btn)
+        row_1_button_widget_layout.addWidget(accept_btn)
+        row_2_button_widget_layout.addWidget(self.save_btn)
         return button_widget
 
     def _accept(self):
@@ -595,16 +619,31 @@ class IPythonConsole(RichJupyterWidget):
         self._control.setPalette(palette)
 
         # Override the stylesheet to force background and text colors
-        # self._control.setStyleSheet("""
-        #             background-color: #615f5f;
-        #             color: #3ba8e7;
-        #             selection-background-color: #006400;
-        #             selection-color: white;
-        #         """)
+        self.style_sheet = '''\
+    QPlainTextEdit, QTextEdit {
+        background-color: %(bgcolor)s;
+        background-clip: padding;
+        color: %(fgcolor)s;
+        selection-background-color: %(select)s;
+    }
+    .inverted {
+        background-color: %(fgcolor)s;
+        color: %(bgcolor)s;
+    }
+    .error { color: red; }
+    .in-prompt-number { font-weight: bold; color: %(in_prompt_number_color)s} }
+    .in-prompt { font-weight: bold; color: %(in_prompt_color)s }
+    .out-prompt-number { font-weight: bold; color: %(out_prompt_number_color)s }
+    .out-prompt { font-weight: bold; color: %(out_prompt_color)s }
+'''%dict(
+            bgcolor='#0b0d0b', fgcolor='#47d9cc', select="#555",
+            in_prompt_number_color='lime', in_prompt_color='lime',
+            out_prompt_number_color='red', out_prompt_color='red'
+        )
 
         # Use a dark syntax style like monokai
-        # self.syntax_style = 'monokai'
-        self.set_default_style(colors='linux')
+        self.syntax_style = 'monokai'
+        # self.set_default_style(colors='lightbg')
 
         self.exit_requested.connect(self.stop)
 

{ripple_down_rules-0.4.2.dist-info → ripple_down_rules-0.4.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ripple_down_rules
-Version: 0.4.2
+Version: 0.4.3
 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
@@ -714,8 +714,9 @@ sudo apt-get install libxcb-cursor-dev
 
 Fit the SCRDR to the data, then classify one of the data cases to check if its correct,
 and render the tree to a file:
+```
 
-```Python
+```python
 from ripple_down_rules.datastructures.dataclasses import CaseQuery
 from ripple_down_rules.rdr import SingleClassRDR
 from ripple_down_rules.datasets import load_zoo_dataset
@@ -736,3 +737,14 @@ render_tree(scrdr.start_rule, use_dot_exporter=True, filename="scrdr")
 cat = scrdr.classify(all_cases[50])
 assert cat == targets[50]
 ```
+
+## To Cite:
+
+```bib
+@software{bassiouny2025rdr,
+author = {Bassiouny, Abdelrhman},
+title = {Ripple-Down-Rules},
+url = {https://github.com/AbdelrhmanBassiouny/ripple_down_rules},
+version = {0.4.1},
+}
+```

{ripple_down_rules-0.4.2.dist-info → ripple_down_rules-0.4.3.dist-info}/RECORD

@@ -3,7 +3,7 @@ ripple_down_rules/datasets.py,sha256=fJbZ7V-UUYTu5XVVpFinTbuzN3YePCnUB01L3AyZVM8
 ripple_down_rules/experts.py,sha256=S-d1EZP0SK0Ab_pMzgkOcLvZFLMdSm8_C0u3AgfouUc,6468
 ripple_down_rules/failures.py,sha256=E6ajDUsw3Blom8eVLbA7d_Qnov2conhtZ0UmpQ9ZtSE,302
 ripple_down_rules/helpers.py,sha256=TvTJU0BA3dPcAyzvZFvAu7jZqsp8Lu0HAAwvuizlGjg,2018
-ripple_down_rules/rdr.py,sha256=UhFKsb7bCKLfplZhCSY-FAulvMfsBqVk_-K7o5WMP4o,43709
+ripple_down_rules/rdr.py,sha256=cO5QUtrKDaOk75GUnBwxzq-ZYzFbJhgycX6BKeLEVtM,44258
 ripple_down_rules/rdr_decorators.py,sha256=VdmE0JrE8j89b6Af1R1tLZiKfy3h1VCvhAUefN_FLLQ,6753
 ripple_down_rules/rules.py,sha256=QQy7NBG6mKiowxVG_LjQJBxLTDW2hMyx5zAgwUxdCMM,17183
 ripple_down_rules/utils.py,sha256=kJEqmKuq3NxM8gY7MrXSps2Xvf1FsYFgTMo3PSYZJY8,49098
@@ -13,13 +13,13 @@ ripple_down_rules/datastructures/case.py,sha256=oC8OSdhXvHE-Zx1IIQlad-fsKzQQqr6M
 ripple_down_rules/datastructures/dataclasses.py,sha256=GWnUF4h4zfNHSsyBIz3L9y8sLkrXRv0FK_OxzzLc8L8,8183
 ripple_down_rules/datastructures/enums.py,sha256=ce7tqS0otfSTNAOwsnXlhsvIn4iW_Y_N3TNebF3YoZs,5700
 ripple_down_rules/user_interface/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ripple_down_rules/user_interface/gui.py,sha256=p4HIAXXa8ijylw5PIpzHGNL4AhbjKmcInEYg-i7jzlI,25941
+ripple_down_rules/user_interface/gui.py,sha256=GlVUYGpMRikrd-FjYCAamdKFAuTAeiq21ZzQvjVKJ4g,27588
 ripple_down_rules/user_interface/ipython_custom_shell.py,sha256=tc7ms80iPNElm9AYC6i1FlfMKkqHLT8wmOEXg_k9yAU,6275
 ripple_down_rules/user_interface/object_diagram.py,sha256=84JlEH0nQmtGmP8Su5iRX3ZfqByYHbVwd0BQYYPuckY,4436
 ripple_down_rules/user_interface/prompt.py,sha256=tQyIrRno1YuS3K0c4p48FVTdDJGG0HCE63WHVKpSJ1I,7976
 ripple_down_rules/user_interface/template_file_creator.py,sha256=PegwW_g8UScjEF2GGe1eV0VoWUzxPhA27L9ExbL7Y_E,12610
-ripple_down_rules-0.4.2.dist-info/licenses/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
-ripple_down_rules-0.4.2.dist-info/METADATA,sha256=s8NdJ2_MsA-ABMI1mO5jsDb-waIEA2pvFLNnQCw3ysk,42668
-ripple_down_rules-0.4.2.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-ripple_down_rules-0.4.2.dist-info/top_level.txt,sha256=VeoLhEhyK46M1OHwoPbCQLI1EifLjChqGzhQ6WEUqeM,18
-ripple_down_rules-0.4.2.dist-info/RECORD,,
+ripple_down_rules-0.4.3.dist-info/licenses/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
+ripple_down_rules-0.4.3.dist-info/METADATA,sha256=gT-m0t8DxQkY2a7qqne4CxS-6WnobM0LGBa4dBlMOwo,42875
+ripple_down_rules-0.4.3.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
+ripple_down_rules-0.4.3.dist-info/top_level.txt,sha256=VeoLhEhyK46M1OHwoPbCQLI1EifLjChqGzhQ6WEUqeM,18
+ripple_down_rules-0.4.3.dist-info/RECORD,,

{ripple_down_rules-0.4.2.dist-info → ripple_down_rules-0.4.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.7.1)
+Generator: setuptools (80.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any