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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (136) hide show
  1. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/PKG-INFO +6 -2
  2. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/README.md +5 -1
  3. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/doc/intro.md +34 -22
  4. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/__init__.py +1 -1
  5. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules.egg-info/PKG-INFO +6 -2
  6. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/.github/workflows/build_and_deploy_doc.yml +0 -0
  7. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/.github/workflows/ci.yml +0 -0
  8. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/.github/workflows/publish-to-test-pypi.yml +0 -0
  9. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/.idea/shelf/Uncommitted_changes_before_Checkout_at_2_4_25,_6_32_PM_[Changes]/shelved.patch +0 -0
  10. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/.idea/shelf/Uncommitted_changes_before_Checkout_at_2_4_25,_6_32_PM_[Changes]1/shelved.patch +0 -0
  11. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/LICENSE +0 -0
  12. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/doc/_config.yml +0 -0
  13. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/doc/_toc.yml +0 -0
  14. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/doc/bibliography.md +0 -0
  15. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/doc/references.bib +0 -0
  16. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/doc/requirements.txt +0 -0
  17. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/examples/__init__.py +0 -0
  18. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/examples/animal_species.py +0 -0
  19. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/examples/part_containment_rdr/__init__.py +0 -0
  20. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/examples/part_containment_rdr/rdr_metadata/part_containment_rdr.json +0 -0
  21. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/examples/part_containment_rdr/robot_contained_objects_mcrdr.py +0 -0
  22. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/examples/part_containment_rdr/robot_contained_objects_mcrdr_defs.py +0 -0
  23. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/examples/part_containment_rdr/robot_rdr.py +0 -0
  24. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/examples/relational_example.py +0 -0
  25. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/images/thinking_pr2.jpg +0 -0
  26. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/pyproject.toml +0 -0
  27. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/pytest.ini +0 -0
  28. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/requirements-dev-ci.txt +0 -0
  29. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/requirements-dev.txt +0 -0
  30. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/requirements-gui.txt +0 -0
  31. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/requirements-viz.txt +0 -0
  32. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/requirements.txt +0 -0
  33. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/complete_mcrdr_extra.dot +0 -0
  34. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/complete_mcrdr_extra.png +0 -0
  35. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/complete_mcrdr_stop_only.dot +0 -0
  36. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/complete_mcrdr_stop_only.png +0 -0
  37. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/complete_mcrdr_stop_plus_rule.dot +0 -0
  38. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/complete_mcrdr_stop_plus_rule.png +0 -0
  39. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/complete_scrdr.dot +0 -0
  40. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/complete_scrdr.png +0 -0
  41. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/complete_scrdr_2.dot +0 -0
  42. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/complete_scrdr_2.png +0 -0
  43. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/complete_scrdr_3.dot +0 -0
  44. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/complete_scrdr_3.png +0 -0
  45. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/grdr_Habitat.dot +0 -0
  46. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/grdr_Habitat.png +0 -0
  47. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/grdr_Species.dot +0 -0
  48. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/grdr_Species.png +0 -0
  49. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/mcrdr_extra.dot +0 -0
  50. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/mcrdr_extra.png +0 -0
  51. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/mcrdr_extra_classify.dot +0 -0
  52. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/mcrdr_extra_classify.png +0 -0
  53. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/mcrdr_stop_plus_rule_combined.dot +0 -0
  54. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/mcrdr_stop_plus_rule_combined.png +0 -0
  55. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/partial_mcrdr_extra.dot +0 -0
  56. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/partial_mcrdr_extra.png +0 -0
  57. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/relational_scrdr_classify.dot +0 -0
  58. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/results/relational_scrdr_classify.png +0 -0
  59. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/setup.cfg +0 -0
  60. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/datastructures/__init__.py +0 -0
  61. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/datastructures/callable_expression.py +0 -0
  62. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/datastructures/case.py +0 -0
  63. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/datastructures/dataclasses.py +0 -0
  64. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/datastructures/enums.py +0 -0
  65. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/experts.py +0 -0
  66. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/helpers.py +0 -0
  67. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/rdr.py +0 -0
  68. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/rdr_decorators.py +0 -0
  69. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/rules.py +0 -0
  70. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/start-code-server.sh +0 -0
  71. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/user_interface/__init__.py +0 -0
  72. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/user_interface/gui.py +0 -0
  73. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/user_interface/ipython_custom_shell.py +0 -0
  74. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/user_interface/object_diagram.py +0 -0
  75. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/user_interface/prompt.py +0 -0
  76. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/user_interface/template_file_creator.py +0 -0
  77. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules/utils.py +0 -0
  78. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules.egg-info/SOURCES.txt +0 -0
  79. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules.egg-info/dependency_links.txt +0 -0
  80. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules.egg-info/requires.txt +0 -0
  81. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/src/ripple_down_rules.egg-info/top_level.txt +0 -0
  82. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/datasets.py +0 -0
  83. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/correct_drawer_rdr_expert_answers_fit.json +0 -0
  84. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/grdr_expert_answers_classify.json +0 -0
  85. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/grdr_expert_answers_fit.json +0 -0
  86. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/grdr_expert_answers_fit_extra.json +0 -0
  87. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/grdr_expert_answers_fit_no_targets.json +0 -0
  88. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/mcrdr_expert_answers_classify.json +0 -0
  89. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/mcrdr_expert_answers_fit_no_targets.json +0 -0
  90. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/mcrdr_expert_answers_stop_only_fit.json +0 -0
  91. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/mcrdr_extra_expert_answers_classify.json +0 -0
  92. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/mcrdr_extra_expert_answers_fit.json +0 -0
  93. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/mcrdr_multi_line_expert_answers_fit.json +0 -0
  94. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/mcrdr_stop_only_answers_fit.json +0 -0
  95. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/mcrdr_stop_plus_rule_answers_fit.json +0 -0
  96. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/mcrdr_stop_plus_rule_combined_expert_answers_fit.json +0 -0
  97. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/mcrdr_stop_plus_rule_expert_answers_fit.json +0 -0
  98. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/mutagenic_expert_answers.json +0 -0
  99. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/relational_scrdr_expert_answers_classify.json +0 -0
  100. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/scrdr_expert_answers_classify.json +0 -0
  101. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/scrdr_expert_answers_fit.json +0 -0
  102. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/scrdr_expert_answers_fit_no_targets.json +0 -0
  103. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/scrdr_multi_line_expert_answers_fit.json +0 -0
  104. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/scrdr_world_expert_answers_fit.json +0 -0
  105. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_expert_answers/view_rdr_expert_answers_fit.json +0 -0
  106. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_generated_rdrs/__init__.py +0 -0
  107. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_helpers/__init__.py +0 -0
  108. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_helpers/helpers.py +0 -0
  109. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_helpers/object_diagram_case_query.png +0 -0
  110. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_helpers/object_diagram_person.png +0 -0
  111. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_json_serialization.py +0 -0
  112. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_object_diagram.py +0 -0
  113. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_on_mutagenic.py +0 -0
  114. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_rdr.py +0 -0
  115. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_rdr_alchemy.py +0 -0
  116. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_rdr_decorators.py +0 -0
  117. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_rdr_world.py +0 -0
  118. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_relational_rdr.py +0 -0
  119. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_relational_rdr_alchemy.py +0 -0
  120. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_results/datasets_physical_object_is_a_robot/__init__.py +0 -0
  121. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_results/datasets_physical_object_is_a_robot/physical_object_is_a_robot_output__scrdr.py +0 -0
  122. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_results/datasets_physical_object_is_a_robot/physical_object_is_a_robot_output__scrdr_defs.py +0 -0
  123. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_results/datasets_physical_object_is_a_robot/physical_object_is_a_robot_rdr.py +0 -0
  124. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_results/datasets_physical_object_is_a_robot/rdr_metadata/datasets_physical_object_is_a_robot.json +0 -0
  125. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_results/datasets_physical_object_select_objects_that_are_parts_of_robot/__init__.py +0 -0
  126. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_results/datasets_physical_object_select_objects_that_are_parts_of_robot/physical_object_select_objects_that_are_parts_of_robot_output__mcrdr.py +0 -0
  127. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_results/datasets_physical_object_select_objects_that_are_parts_of_robot/physical_object_select_objects_that_are_parts_of_robot_output__mcrdr_defs.py +0 -0
  128. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_results/datasets_physical_object_select_objects_that_are_parts_of_robot/physical_object_select_objects_that_are_parts_of_robot_rdr.py +0 -0
  129. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_results/datasets_physical_object_select_objects_that_are_parts_of_robot/rdr_metadata/datasets_physical_object_select_objects_that_are_parts_of_robot.json +0 -0
  130. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_sql_model.py +0 -0
  131. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_template_file_creator.py +0 -0
  132. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_user_interface/__init__.py +0 -0
  133. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_user_interface/test_ipython.py +0 -0
  134. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_user_interface/test_ipython_copilot.py +0 -0
  135. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_user_interface/test_qt_gui_inline.py +0 -0
  136. {ripple_down_rules-0.5.3 → ripple_down_rules-0.5.41}/test/test_utils.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ripple_down_rules
3
- Version: 0.5.3
3
+ Version: 0.5.41
4
4
  Summary: Implements the various versions of Ripple Down Rules (RDR) for knowledge representation and reasoning.
5
5
  Author-email: Abdelrhman Bassiouny <abassiou@uni-bremen.de>
6
6
  License: GNU GENERAL PUBLIC LICENSE
@@ -725,6 +725,10 @@ For GUI support, also install:
725
725
  sudo apt-get install libxcb-cursor-dev
726
726
  ```
727
727
 
728
+ ## Documentation
729
+
730
+ Read the documentation [here](https://abdelrhmanbassiouny.github.io/ripple_down_rules/).
731
+
728
732
  ## Example Usage
729
733
 
730
734
  ### Propositional Example
@@ -887,6 +891,6 @@ try that yourself and see if it works!
887
891
  author = {Bassiouny, Abdelrhman},
888
892
  title = {Ripple-Down-Rules},
889
893
  url = {https://github.com/AbdelrhmanBassiouny/ripple_down_rules},
890
- version = {0.5.2},
894
+ version = {0.5.4},
891
895
  }
892
896
  ```
@@ -21,6 +21,10 @@ For GUI support, also install:
21
21
  sudo apt-get install libxcb-cursor-dev
22
22
  ```
23
23
 
24
+ ## Documentation
25
+
26
+ Read the documentation [here](https://abdelrhmanbassiouny.github.io/ripple_down_rules/).
27
+
24
28
  ## Example Usage
25
29
 
26
30
  ### Propositional Example
@@ -183,6 +187,6 @@ try that yourself and see if it works!
183
187
  author = {Bassiouny, Abdelrhman},
184
188
  title = {Ripple-Down-Rules},
185
189
  url = {https://github.com/AbdelrhmanBassiouny/ripple_down_rules},
186
- version = {0.5.2},
190
+ version = {0.5.4},
187
191
  }
188
192
  ```
@@ -13,27 +13,39 @@ SCRDR, MCRDR, and GRDR logic were inspired from the book:
13
13
  ["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.
14
14
 
15
15
 
16
- Additionally, to the main ripple down rules benefits, this package also features:
17
-
18
- - Ontology and Rule base as one entity
19
- - Both use same python data structures.
20
- - Update in data structures reflects in Rule base.
21
- - Both are under one versioning system, the rule base is generated as a python module that becomes part of your
22
- project.
23
- - First, second, and higher order logic is achieved by freely writing python code.
24
- - Rule conditions and conclusions are python functions that can do anything that python can do.
25
- - Automatic maintenance of rule base.
26
- - When rules are added contradictions are detected and prompted to the user to add a refinement rule for
27
- to resolve the contradiction.
28
- - Transparent Editable rule base
29
- - Rules are understandable python code that can be manually edited and reloaded.
30
- - Interface that makes coders feel at home by using their favorite IDE.
31
- - Uses latest technologies like LLMs to help in writing the rules (Inherited feature from IDEs).
32
- - Auto completions and suggestions in the IDE.
33
- - Ask AI available with the press of a button to help in writing the rule.
34
- - Rules can be for instances on very specific scenarios and can be very general on super class relations.
35
- - Accompanied by a GUI with an object explorer panel and an expandable/retractable object diagram to help in
36
- writing the rules about the object at hand.
16
+ ## 🚀 Enhanced Ripple-Down Rules Engine Key Features
17
+
18
+ ### 🧠 Ontology + Rule Base as One Entity
19
+ - 🧬 Unified data structure: Ontology and rules use the same Python data structures.
20
+ - 🔄 Automatic sync: Updates to the ontology instantly reflect in the rule base.
21
+ - 📦 Version controlled: The rule base is a Python module, versioned with your project.
22
+
23
+ ### 🔁 Supports First, Second & Higher-Order Logic
24
+ - 🧩 Unlimited expressiveness: Rule conditions and conclusions are plain Python functions anything Python can do, your rules can too!
25
+
26
+ ### 🛡️ Automatic Rule Base Maintenance
27
+ - ⚠️ Contradiction detection: New rules are auto-checked for logical conflicts.
28
+ - 🔧 Prompted refinements: If a contradiction arises, you're guided to add a refinement rule.
29
+
30
+ ### 📝 Transparent & Editable Rule Base
31
+ - 📖 Readable rules: Rules are clean, understandable Python code.
32
+ - 🔄 Reload-friendly: Easily edit and reload rules manually as needed.
33
+
34
+ ### 💻 Developer-Centric Interface
35
+ - 👨‍💻 Feels like home: Seamless integration with your favorite IDE.
36
+ - Modern coding experience: Auto-completion and suggestions supported via IDE plugins.
37
+
38
+ ### 🤖 LLM-Powered Rule Writing
39
+ - 💡 AI-assisted authoring: Ask AI for help or suggestions directly within the IDE.
40
+ - ⚡ Smart completion: Context-aware completions streamline rule writing.
41
+
42
+ ### 🎯 Flexible Rule Specificity
43
+ - 🧪 Instance-level precision: Write rules for highly specific object scenarios.
44
+ - 🏛️ Generalization-ready: Create broad rules for superclass relationships.
45
+
46
+ ### 🖼️ GUI for Rule Exploration
47
+ - 🧭 Object Explorer Panel: Navigate and inspect objects easily.
48
+ - 🧯 Interactive Diagram: Expandable/collapsible object diagram to guide rule creation visually.
37
49
 
38
50
  This work aims to provide a flexible and powerful rule-based system that can be used in various applications,
39
51
  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
51
63
  author = {Bassiouny, Abdelrhman},
52
64
  title = {Ripple-Down-Rules},
53
65
  url = {https://github.com/AbdelrhmanBassiouny/ripple_down_rules},
54
- version = {0.5.2},
66
+ version = {0.5.4},
55
67
  }
56
68
  ```
57
69
 
@@ -1,4 +1,4 @@
1
- __version__ = "0.5.3"
1
+ __version__ = "0.5.41"
2
2
 
3
3
  import logging
4
4
  logger = logging.Logger("rdr")
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ripple_down_rules
3
- Version: 0.5.3
3
+ Version: 0.5.41
4
4
  Summary: Implements the various versions of Ripple Down Rules (RDR) for knowledge representation and reasoning.
5
5
  Author-email: Abdelrhman Bassiouny <abassiou@uni-bremen.de>
6
6
  License: GNU GENERAL PUBLIC LICENSE
@@ -725,6 +725,10 @@ For GUI support, also install:
725
725
  sudo apt-get install libxcb-cursor-dev
726
726
  ```
727
727
 
728
+ ## Documentation
729
+
730
+ Read the documentation [here](https://abdelrhmanbassiouny.github.io/ripple_down_rules/).
731
+
728
732
  ## Example Usage
729
733
 
730
734
  ### Propositional Example
@@ -887,6 +891,6 @@ try that yourself and see if it works!
887
891
  author = {Bassiouny, Abdelrhman},
888
892
  title = {Ripple-Down-Rules},
889
893
  url = {https://github.com/AbdelrhmanBassiouny/ripple_down_rules},
890
- version = {0.5.2},
894
+ version = {0.5.4},
891
895
  }
892
896
  ```