ripple-down-rules 0.4.88__tar.gz → 0.5.1__tar.gz

ripple_down_rules-0.5.1/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+# .github/workflows/ci.yml
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10']
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        sudo apt install graphviz graphviz-dev
+        python -m pip install --upgrade pip
+        pip install virtualenv
+        python -m virtualenv venv
+        source venv/bin/activate
+        pip install -r requirements-dev-ci.txt
+        pip install pytest mypy flake8 black isort
+        pip install .
+
+    - name: Run tests
+      run: |
+        source venv/bin/activate
+        cd test
+        pytest

{ripple_down_rules-0.4.88 → ripple_down_rules-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ripple_down_rules
-Version: 0.4.88
+Version: 0.5.1
 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,6 +693,7 @@ Requires-Dist: colorama
 Requires-Dist: pygments
 Requires-Dist: sqlalchemy
 Requires-Dist: pandas
+Requires-Dist: pyparsing
 Provides-Extra: viz
 Requires-Dist: networkx>=3.1; extra == "viz"
 Requires-Dist: matplotlib>=3.7.5; extra == "viz"
@@ -735,7 +736,7 @@ and render the tree to a file:
 ```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
+from datasets import load_zoo_dataset
 from ripple_down_rules.utils import render_tree
 
 all_cases, targets = load_zoo_dataset()

{ripple_down_rules-0.4.88 → ripple_down_rules-0.5.1}/README.md

@@ -32,7 +32,7 @@ and render the tree to a file:
 ```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
+from datasets import load_zoo_dataset
 from ripple_down_rules.utils import render_tree
 
 all_cases, targets = load_zoo_dataset()

{ripple_down_rules-0.4.88 → ripple_down_rules-0.5.1}/examples/readme_example.py

@@ -1,6 +1,6 @@
 from ripple_down_rules.datastructures.dataclasses import CaseQuery
 from ripple_down_rules.rdr import SingleClassRDR
-from ripple_down_rules.datasets import load_zoo_dataset
+from datasets import load_zoo_dataset
 from ripple_down_rules.utils import render_tree
 
 all_cases, targets = load_zoo_dataset()

ripple_down_rules-0.5.1/requirements-dev-ci.txt

@@ -0,0 +1,4 @@
+-r requirements.txt
+ucimlrepo>=0.0.7
+pdbpp
+pytest

{ripple_down_rules-0.4.88 → ripple_down_rules-0.5.1}/requirements.txt

@@ -9,4 +9,5 @@ requests
 colorama
 pygments
 sqlalchemy
-pandas
+pandas
+pyparsing

{ripple_down_rules-0.4.88 → ripple_down_rules-0.5.1}/src/ripple_down_rules/__init__.py

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

{ripple_down_rules-0.4.88 → ripple_down_rules-0.5.1}/src/ripple_down_rules/datastructures/callable_expression.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import ast
 import logging
+import os
 from _ast import AST
 from enum import Enum
 
@@ -10,7 +11,7 @@ from typing_extensions import Type, Optional, Any, List, Union, Tuple, Dict, Set
 from .case import create_case, Case
 from ..utils import SubclassJSONSerializer, get_full_class_name, get_type_from_string, conclusion_to_json, is_iterable, \
     build_user_input_from_conclusion, encapsulate_user_input, extract_function_source, are_results_subclass_of_types, \
-    make_list
+    make_list, get_imports_from_scope
 
 
 class VariableVisitor(ast.NodeVisitor):
@@ -175,6 +176,24 @@ class CallableExpression(SubclassJSONSerializer):
             return
         self.user_input = self.encapsulating_function + '\n' + new_function_body
 
+    def write_to_python_file(self, file_path: str, append: bool = False):
+        """
+        Write the callable expression to a python file.
+
+        :param file_path: The path to the file where the callable expression will be written.
+        :param append: If True, the callable expression will be appended to the file. If False,
+         the file will be overwritten.
+        """
+        imports = '\n'.join(get_imports_from_scope(self.scope))
+        if append and os.path.exists(file_path):
+            with open(file_path, 'a') as f:
+                f.write('\n\n\n' + imports + '\n\n\n')
+                f.write(self.user_input)
+        else:
+            with open(file_path, 'w') as f:
+                f.write(imports + '\n\n\n')
+                f.write(self.user_input)
+
     @property
     def user_input(self):
         """

{ripple_down_rules-0.4.88 → ripple_down_rules-0.5.1}/src/ripple_down_rules/datastructures/dataclasses.py

@@ -78,7 +78,15 @@ class CaseQuery:
         """
         :return: The type of the case that the attribute belongs to.
         """
-        return self.original_case._obj_type if isinstance(self.original_case, Case) else type(self.original_case)
+        if self.is_function:
+            if self.function_args_type_hints is not None:
+                func_args = [arg for name, arg in self.function_args_type_hints.items() if name != 'return']
+                case_type_args = Union[tuple(func_args)]
+            else:
+                case_type_args = Any
+            return Dict[str, case_type_args]
+        else:
+            return self.original_case._obj_type if isinstance(self.original_case, Case) else type(self.original_case)
 
     @property
     def case(self) -> Any:

ripple_down_rules-0.5.1/src/ripple_down_rules/experts.py

@@ -0,0 +1,317 @@
+from __future__ import annotations
+
+import ast
+import json
+import logging
+import os
+from abc import ABC, abstractmethod
+
+from typing_extensions import Optional, TYPE_CHECKING, List
+
+from .datastructures.callable_expression import CallableExpression
+from .datastructures.enums import PromptFor
+from .datastructures.dataclasses import CaseQuery
+from .datastructures.case import show_current_and_corner_cases
+from .utils import extract_imports, extract_function_source, get_imports_from_scope, encapsulate_user_input
+
+try:
+    from .user_interface.gui import RDRCaseViewer
+except ImportError as e:
+    RDRCaseViewer = None
+from .user_interface.prompt import UserPrompt
+
+if TYPE_CHECKING:
+    from .rdr import Rule
+
+
+class Expert(ABC):
+    """
+    The Abstract Expert class, all experts should inherit from this class.
+    An expert is a class that can provide differentiating features and conclusions for a case when asked.
+    The expert can compare a case with a corner case and provide the differentiating features and can also
+    provide one or multiple conclusions for a case.
+    """
+    all_expert_answers: Optional[List] = None
+    """
+    A list of all expert answers, used for testing purposes.
+    """
+    use_loaded_answers: bool = False
+    """
+    A flag to indicate if the expert should use loaded answers or not.
+    """
+
+    def __init__(self, use_loaded_answers: bool = True,
+                 append: bool = False,
+                 answers_save_path: Optional[str] = None):
+        self.all_expert_answers = []
+        self.use_loaded_answers = use_loaded_answers
+        self.append = append
+        self.answers_save_path = answers_save_path
+        if answers_save_path is not None:
+            if use_loaded_answers:
+                self.load_answers(answers_save_path)
+            else:
+                os.remove(answers_save_path + '.py')
+            self.append = True
+
+    @abstractmethod
+    def ask_for_conditions(self, case_query: CaseQuery, last_evaluated_rule: Optional[Rule] = None) \
+            -> CallableExpression:
+        """
+        Ask the expert to provide the differentiating features between two cases or unique features for a case
+        that doesn't have a corner case to compare to.
+
+        :param case_query: The case query containing the case to classify and the required target.
+        :param last_evaluated_rule: The last evaluated rule.
+        :return: The differentiating features as new rule conditions.
+        """
+        pass
+
+    @abstractmethod
+    def ask_for_conclusion(self, case_query: CaseQuery) -> Optional[CallableExpression]:
+        """
+        Ask the expert to provide a relational conclusion for the case.
+
+        :param case_query: The case query containing the case to find a conclusion for.
+        :return: A callable expression that can be called with a new case as an argument.
+        """
+
+    def clear_answers(self, path: Optional[str] = None):
+        """
+        Clear the expert answers.
+
+        :param path: The path to clear the answers from. If None, the answers will be cleared from the
+                     answers_save_path attribute.
+        """
+        if path is None and self.answers_save_path is None:
+            raise ValueError("No path provided to clear expert answers, either provide a path or set the "
+                                "answers_save_path attribute.")
+        if path is None:
+            path = self.answers_save_path
+        if os.path.exists(path + '.json'):
+            os.remove(path + '.json')
+        if os.path.exists(path + '.py'):
+            os.remove(path + '.py')
+        self.all_expert_answers = []
+
+    def save_answers(self, path: Optional[str] = None):
+        """
+        Save the expert answers to a file.
+
+        :param path: The path to save the answers to.
+        """
+        if path is None and self.answers_save_path is None:
+            raise ValueError("No path provided to save expert answers, either provide a path or set the "
+                                "answers_save_path attribute.")
+        if path is None:
+            path = self.answers_save_path
+        is_json = os.path.exists(path + '.json')
+        if is_json:
+            self._save_to_json(path)
+        else:
+            self._save_to_python(path)
+
+    def _save_to_json(self, path: str):
+        """
+        Save the expert answers to a JSON file.
+
+        :param path: The path to save the answers to.
+        """
+        all_answers = self.all_expert_answers
+        if self.append and os.path.exists(path + '.json'):
+            # read the file and append the new answers
+            with open(path + '.json', "r") as f:
+                old_answers = json.load(f)
+                all_answers = old_answers + all_answers
+        with open(path + '.json', "w") as f:
+            json.dump(all_answers, f)
+
+    def _save_to_python(self, path: str):
+        """
+        Save the expert answers to a Python file.
+
+        :param path: The path to save the answers to.
+        """
+        dir_name = os.path.dirname(path)
+        if not os.path.exists(dir_name + '/__init__.py'):
+            os.makedirs(dir_name, exist_ok=True)
+            with open(dir_name + '/__init__.py', 'w') as f:
+                f.write('# This is an empty init file to make the directory a package.\n')
+        action = 'w' if not self.append else 'a'
+        with open(path + '.py', action) as f:
+            for scope, func_source in self.all_expert_answers:
+                if len(scope) > 0:
+                    imports = '\n'.join(get_imports_from_scope(scope)) + '\n\n\n'
+                else:
+                    imports = ''
+                if func_source is not None:
+                    func_source = encapsulate_user_input(func_source, CallableExpression.encapsulating_function)
+                else:
+                    func_source = 'pass  # No user input provided for this case.\n'
+                f.write(imports + func_source + '\n' + '\n\n\n\'===New Answer===\'\n\n\n')
+
+    def load_answers(self, path: Optional[str] = None):
+        """
+        Load the expert answers from a file.
+
+        :param path: The path to load the answers from.
+        """
+        if path is None and self.answers_save_path is None:
+            raise ValueError("No path provided to load expert answers from, either provide a path or set the "
+                                "answers_save_path attribute.")
+        if path is None:
+            path = self.answers_save_path
+        is_json = os.path.exists(path + '.json')
+        if is_json:
+            self._load_answers_from_json(path)
+        elif os.path.exists(path + '.py'):
+            self._load_answers_from_python(path)
+
+    def _load_answers_from_json(self, path: str):
+        """
+        Load the expert answers from a JSON file.
+
+        :param path: The path to load the answers from.
+        """
+        with open(path + '.json', "r") as f:
+            all_answers = json.load(f)
+        self.all_expert_answers = [({}, answer) for answer in all_answers]
+
+    def _load_answers_from_python(self, path: str):
+        """
+        Load the expert answers from a Python file.
+
+        :param path: The path to load the answers from.
+        """
+        file_path = path + '.py'
+        with open(file_path, "r") as f:
+            all_answers = f.read().split('\n\n\n\'===New Answer===\'\n\n\n')
+        for answer in all_answers:
+            answer = answer.strip('\n').strip()
+            if 'def ' not in answer and 'pass' in answer:
+                self.all_expert_answers.append(({}, None))
+            scope = extract_imports(tree=ast.parse(answer))
+            func_source = list(extract_function_source(file_path, []).values())[0]
+            self.all_expert_answers.append((scope, func_source))
+
+
+class Human(Expert):
+    """
+    The Human Expert class, an expert that asks the human to provide differentiating features and conclusions.
+    """
+
+    def __init__(self, viewer: Optional[RDRCaseViewer] = None, **kwargs):
+        """
+        Initialize the Human expert.
+
+        :param viewer: The RDRCaseViewer instance to use for prompting the user.
+        """
+        super().__init__(**kwargs)
+        self.user_prompt = UserPrompt(viewer)
+
+    def ask_for_conditions(self, case_query: CaseQuery,
+                           last_evaluated_rule: Optional[Rule] = None) \
+            -> CallableExpression:
+        if not self.use_loaded_answers and self.user_prompt.viewer is None:
+            show_current_and_corner_cases(case_query.case, {case_query.attribute_name: case_query.target_value},
+                                          last_evaluated_rule=last_evaluated_rule)
+        return self._get_conditions(case_query)
+
+    def _get_conditions(self, case_query: CaseQuery) \
+            -> CallableExpression:
+        """
+        Ask the expert to provide the differentiating features between two cases or unique features for a case
+        that doesn't have a corner case to compare to.
+
+        :param case_query: The case query containing the case to classify.
+        :return: The differentiating features as new rule conditions.
+        """
+        user_input = None
+        if self.use_loaded_answers and len(self.all_expert_answers) == 0 and self.append:
+            self.use_loaded_answers = False
+        if self.use_loaded_answers:
+            try:
+                loaded_scope, user_input = self.all_expert_answers.pop(0)
+            except IndexError:
+                self.use_loaded_answers = False
+        if user_input is not None:
+            condition = CallableExpression(user_input, bool, scope=case_query.scope)
+        else:
+            user_input, condition = self.user_prompt.prompt_user_for_expression(case_query, PromptFor.Conditions)
+        if not self.use_loaded_answers:
+            self.all_expert_answers.append((condition.scope, user_input))
+            if self.answers_save_path is not None:
+                self.save_answers()
+        case_query.conditions = condition
+        return condition
+
+    def ask_for_conclusion(self, case_query: CaseQuery) -> Optional[CallableExpression]:
+        """
+        Ask the expert to provide a conclusion for the case.
+
+        :param case_query: The case query containing the case to find a conclusion for.
+        :return: The conclusion for the case as a callable expression.
+        """
+        expression: Optional[CallableExpression] = None
+        expert_input: Optional[str] = None
+        if self.use_loaded_answers and len(self.all_expert_answers) == 0 and self.append:
+            self.use_loaded_answers = False
+        if self.use_loaded_answers:
+            try:
+                loaded_scope, expert_input = self.all_expert_answers.pop(0)
+                if expert_input is not None:
+                    expression = CallableExpression(expert_input, case_query.attribute_type,
+                                                    scope=case_query.scope,
+                                                    mutually_exclusive=case_query.mutually_exclusive)
+            except IndexError:
+                self.use_loaded_answers = False
+        if not self.use_loaded_answers:
+            if self.user_prompt.viewer is None:
+                show_current_and_corner_cases(case_query.case)
+            expert_input, expression = self.user_prompt.prompt_user_for_expression(case_query, PromptFor.Conclusion)
+            if expression is None:
+                self.all_expert_answers.append(({}, None))
+            else:
+                self.all_expert_answers.append((expression.scope, expert_input))
+            if self.answers_save_path is not None:
+                self.save_answers()
+        case_query.target = expression
+        return expression
+
+
+class File(Expert):
+    """
+    The File Expert class, an expert that reads the answers from a file.
+    This is used for testing purposes.
+    """
+
+    def __init__(self, filename: str, **kwargs):
+        """
+        Initialize the File expert.
+
+        :param filename: The path to the file containing the expert answers.
+        """
+        super().__init__(**kwargs)
+        self.filename = filename
+        self.load_answers(filename)
+
+    def ask_for_conditions(self, case_query: CaseQuery,
+                           last_evaluated_rule: Optional[Rule] = None) -> CallableExpression:
+        loaded_scope, user_input = self.all_expert_answers.pop(0)
+        if user_input:
+            condition = CallableExpression(user_input, bool, scope=case_query.scope)
+        else:
+            raise ValueError("No user input found in the expert answers file.")
+        case_query.conditions = condition
+        return condition
+
+    def ask_for_conclusion(self, case_query: CaseQuery) -> Optional[CallableExpression]:
+        loaded_scope, expert_input = self.all_expert_answers.pop(0)
+        if expert_input is not None:
+            expression = CallableExpression(expert_input, case_query.attribute_type,
+                                            scope=case_query.scope,
+                                            mutually_exclusive=case_query.mutually_exclusive)
+        else:
+            raise ValueError("No expert input found in the expert answers file.")
+        case_query.target = expression
+        return expression