Merge pull request #14 from audemard/main

add functionnalities
crillab · Feb 19, 2024 · 18ccc5c · 18ccc5c
2 parents a225ef9 + df8a3b5
commit 18ccc5c
Show file tree

Hide file tree

Showing 33 changed files with 377 additions and 274 deletions.
diff --git a/.github/workflows/test_osx.yml b/.github/workflows/test_osx.yml
@@ -0,0 +1,27 @@
+name: OSX tests
+
+#on: [workflow_dispatch] #Manually
+on: [push]
+#on:
+#  workflow_run:
+#    workflows: ["Build"]
+#    types:
+#      - completed
+
+jobs:
+  tests:
+    runs-on: macos-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v3
+      with:
+        python-version: '3.11'
+    - name: Build a wheel via an sdist
+      run: |
+        pip install build
+        python -m build
+        pip install dist/pyxai*.whl
+#        sudo apt install ffmpeg libsm6 libxext6 qt6-base-dev libxcb-cursor0 -y
+    - name: Run test suite
+      run: |
+        python3 -m pyxai -tests
diff --git a/.gitignore b/.gitignore
@@ -16,6 +16,7 @@
 *.snm
 *.toc
 *.vrb
+*.so
 build
 dist
 requirements-download/

diff --git a/pyxai/README.md b/pyxai/README.md
@@ -134,7 +134,7 @@ contrastive_reason = explainer.contrastive_reason()
 print("contrastive reason", contrastive_reason)
 print("to_features:", explainer.to_features(contrastive_reason, contrastive=True))
 
-explainer.open_GUI()
+explainer.visualisation.gui()
 ```
 
 <img src="https://www.cril.univ-artois.fr/pyxai/assets/figures/pyxaiGUI.png" alt="pyxai" />

diff --git a/pyxai/examples/BT/GUI-mnist38.py b/pyxai/examples/BT/GUI-mnist38.py
@@ -39,7 +39,7 @@ def get_pixel_value(instance, x, y, shape):
 def instance_index_to_pixel_position(i, shape):
     return i // shape[0], i % shape[0]
 
-explainer.show_on_screen(instance, minimal_tree_specific_reason,
+explainer.visualisation.screen(instance, minimal_tree_specific_reason,
                       image={"shape": (28,28),
                       "dtype": numpy.uint8,
                       "get_pixel_value": get_pixel_value,

diff --git a/pyxai/examples/BT/regression/builder-regression.py b/pyxai/examples/BT/regression/builder-regression.py
@@ -38,7 +38,7 @@
 
 print("extremum", explainer.extremum_range())
 print("possible range", explainer.range_for_partial_instance(instance))
-explainer.open_GUI()
+explainer.visualisation.gui()
 #sufficient_reason = explainer.sufficient_reason()
 #print("sufficient: ", sufficient_reason,  explainer.to_features(sufficient_reason))
 #print("is implicant:", explainer.is_implicant(sufficient_reason))
diff --git a/pyxai/examples/BT/regression/simple-regression.py b/pyxai/examples/BT/regression/simple-regression.py
@@ -64,4 +64,4 @@
 print("\ntree_specific: ", explainer.to_features(tree_specific_reason, eliminate_redundant_features=True))
 print("is a tree specific", explainer.is_tree_specific_reason(tree_specific_reason))
 
-explainer.open_GUI()
+explainer.visualisation.gui()
diff --git a/pyxai/examples/DT/GUI-cifar.py b/pyxai/examples/DT/GUI-cifar.py
@@ -76,7 +76,7 @@ def instance_index_to_pixel_position(i, shape):
         value = i - (n_pixels*2)  
     return value // shape[0], value % shape[0]
 
-explainer.open_GUI(image={"shape": (32,32,3),
+explainer.visualisation.gui(image={"shape": (32,32,3),
                       "dtype": numpy.uint8,
                       "get_pixel_value": get_pixel_value,
                       "instance_index_to_pixel_position": instance_index_to_pixel_position})
diff --git a/pyxai/examples/DT/GUI-mnist38-contrastives.py b/pyxai/examples/DT/GUI-mnist38-contrastives.py
@@ -33,7 +33,7 @@ def get_pixel_value(instance, x, y, shape):
 def instance_index_to_pixel_position(i, shape):
     return i // shape[0], i % shape[0]
 
-explainer.open_GUI(image={"shape": (28,28),
+explainer.visualisation.gui(image={"shape": (28,28),
                       "dtype": numpy.uint8,
                       "get_pixel_value": get_pixel_value,
                       "instance_index_to_pixel_position": instance_index_to_pixel_position})

diff --git a/pyxai/examples/DT/GUI-mnist38.py b/pyxai/examples/DT/GUI-mnist38.py
@@ -42,8 +42,8 @@ def instance_index_to_pixel_position(i, shape):
     return i // shape[0], i % shape[0]
 
 # Visualization part
-explainer.heat_map("heat map 1", sufficient_reasons_per_attribute)
-explainer.open_GUI(image={"shape": (28,28),
+explainer.visualisation.heat_map("heat map 1", sufficient_reasons_per_attribute)
+explainer.visualisation.gui(image={"shape": (28,28),
                       "dtype": numpy.uint8,
                       "get_pixel_value": get_pixel_value,
                       "instance_index_to_pixel_position": instance_index_to_pixel_position})
diff --git a/pyxai/examples/DT/builder-loan.py b/pyxai/examples/DT/builder-loan.py
@@ -57,4 +57,4 @@
 for contrastive in contrastives:
     print("contrastive:", explainer.to_features(contrastive, contrastive=True))
 
-explainer.open_GUI()
+explainer.visualisation.gui()
diff --git a/pyxai/examples/DT/builder-orchid.py b/pyxai/examples/DT/builder-orchid.py
@@ -78,4 +78,4 @@
 print("Minimal sufficient reasons:", minimals)
 assert minimals == (-4,), "The minimal sufficient reasons are not good !"
 
-explainer.open_GUI()
+explainer.visualisation.gui()
diff --git a/pyxai/examples/DT/simple.py b/pyxai/examples/DT/simple.py
@@ -47,4 +47,4 @@
 if all_are_contrastive:
     print("All contrastive are ok")
 
-explainer.open_GUI()
+explainer.visualisation.gui()
diff --git a/pyxai/examples/RF/GUI-australian.py b/pyxai/examples/RF/GUI-australian.py
@@ -34,4 +34,4 @@
 #print("\ntree_specific: ", explainer.to_features(majoritary_reason))
 #print("is majoritary:", explainer.is_majoritary_reason(majoritary_reason))
 
-explainer.open_GUI()
+explainer.visualisation.gui()
diff --git a/pyxai/examples/RF/GUI-builder-loan.py b/pyxai/examples/RF/GUI-builder-loan.py
@@ -24,4 +24,4 @@
 print("contrastives (to_features):", explainer.to_features(contrastives[0], contrastive=True))
 print("contrastives (to_features):", explainer.to_features(contrastives[1], contrastive=True))
 
-explainer.open_GUI()
+explainer.visualisation.gui()
diff --git a/pyxai/examples/RF/GUI-mnist49.py b/pyxai/examples/RF/GUI-mnist49.py
@@ -44,7 +44,7 @@ def get_pixel_value(instance, x, y, shape):
 def instance_index_to_pixel_position(i, shape):
     return i // shape[0], i % shape[0]
 
-explainer.open_GUI(image={"shape": (28,28),
+explainer.visualisation.gui(image={"shape": (28,28),
                       "dtype": numpy.uint8,
                       "get_pixel_value": get_pixel_value,
                       "instance_index_to_pixel_position": instance_index_to_pixel_position})

diff --git a/pyxai/examples/RF/builder-categorical-paper.py b/pyxai/examples/RF/builder-categorical-paper.py
@@ -59,4 +59,4 @@
 print("contrastive (to_features):", explainer.to_features(contrastive, contrastive=True))
 print("is contrastive:", explainer.is_contrastive_reason(contrastive))
 
-explainer.open_GUI()
+explainer.visualisation.gui()
diff --git a/pyxai/examples/RF/simple.py b/pyxai/examples/RF/simple.py
@@ -45,4 +45,4 @@
     if explainer.elapsed_time == Explainer.TIMEOUT: print("Time out, this is an approximation")
     print("is  contrastive: ", explainer.is_contrastive_reason(minimal_constrative_reason))
 
-explainer.open_GUI()
+explainer.visualisation.gui()
diff --git a/pyxai/examples/RF/theories-majoritary.py b/pyxai/examples/RF/theories-majoritary.py
@@ -63,4 +63,4 @@
     if explainer.elapsed_time == Explainer.TIMEOUT: print("Time out, this is an approximation")
     print("is  contrastive: ", explainer.is_contrastive_reason(minimal_constrative_reason))
 
-explainer.open_GUI()
+explainer.visualisation.gui()
diff --git a/pyxai/examples/RF/theories-types-file.py b/pyxai/examples/RF/theories-types-file.py
@@ -34,5 +34,5 @@
     features = explainer.to_features(majoritary_reason)
     #print("features majoritary:", features)
 
-explainer.open_GUI()
+explainer.visualisation.gui()
 
diff --git a/pyxai/setup.py b/pyxai/setup.py
@@ -12,7 +12,9 @@ def main():
               ["sources/solvers/GREEDY/src/bt_wrapper.cc", "sources/solvers/GREEDY/src/Explainer.cc", "sources/solvers/GREEDY/src/Tree.cc",
                "sources/solvers/GREEDY/src/Node.cc", "sources/solvers/GREEDY/src/bcp/ParserDimacs.cc", "sources/solvers/GREEDY/src/bcp/Problem.cc",
                "sources/solvers/GREEDY/src/bcp/ProblemTypes.cc", "sources/solvers/GREEDY/src/bcp/Propagator.cc"],
-              language="c++")])
+              language="c++",
+              extra_compile_args=["-std=c++11"]
+          )])
 
 
 if __name__ == "__main__":