psyke 0.4.9.dev6__py3-none-any.whl → 1.0.4.dev10__py3-none-any.whl

{psyke-0.4.9.dev6.dist-info → psyke-1.0.4.dev10.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: psyke
-Version: 0.4.9.dev6
+Version: 1.0.4.dev10
 Summary: Python-based implementation of PSyKE, i.e. a Platform for Symbolic Knowledge Extraction
 Home-page: https://github.com/psykei/psyke-python
 Author: Matteo Magnini
@@ -16,33 +16,55 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Prolog
-Requires-Python: >=3.9.0, <3.10
+Requires-Python: ==3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: numpy (~=1.23.5)
-Requires-Dist: pandas (~=2.0.2)
-Requires-Dist: scikit-learn (~=1.2.0)
-Requires-Dist: 2ppy (~=0.4.0)
-Requires-Dist: kneed (~=0.8.1)
-Requires-Dist: sympy (~=1.11)
+Requires-Dist: numpy~=2.3.4
+Requires-Dist: pandas~=2.3.0
+Requires-Dist: scikit-learn~=1.8.0
+Requires-Dist: 2ppy~=0.4.0
+Requires-Dist: kneed~=0.8.1
+Requires-Dist: sympy~=1.11
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: platform
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # PSyKE
 
 ![PSyKE Logo](.img/logo-wide.png)
 
-Some quick links:
+Quick links:
 * [Home Page](https://apice.unibo.it/xwiki/bin/view/PSyKE/)
 * [GitHub Repository](https://github.com/psykei/psyke-python)
 * [PyPi Repository](https://pypi.org/project/psyke/)
 * [Issues](https://github.com/psykei/psyke-python/issues)
 
+## Latest Releases
+
+* PSyKE 1.0: Compatibility with Python 3.11.x
+* PSyKE 0.10: New genetic algorithms for knowledge extraction
+* PSyKE 0.9: Fairness mitigation support for knowedge extractors
+* PSyKE 0.8: New features: local explainability and counterfactual support
+* PSyKE 0.7: New SKE algorithms implemented
+
 ## Intro
 
 [PSyKE](https://apice.unibo.it/xwiki/bin/view/PSyKE/) (Platform for Symbolic Knowledge Extraction)
-is intended as a library for extracting symbolic knowledge (in the form of logic rules) out of sub-symbolic predictors.
+is intended as a library for extracting symbolic knowledge (in the form of logic rule lists) out of sub-symbolic predictors.
 
 More precisely, PSyKE offers a general purpose API for knowledge extraction, and a number of different algorithms implementing it,
 supporting both classification and regression problems.
@@ -91,16 +113,14 @@ We are working on PSyKE to extend its features to encompass explainable clusteri
 
 ### End users
 
-PSyKE is deployed as a library on Pypi, and it can therefore be installed as Python package by running:
+PSyKE is deployed as a library on Pypi. It can be installed as Python package by running:
 ```bash
 pip install psyke
 ```
 
 #### Requirements
-* `numpy`
-* `pandas`
-* `scikit-learn`
-* `2ppy`
+
+Please refer to the [requirements file](https://github.com/psykei/psyke-python/blob/master/requirements.txt)
 
 ##### Test requirements
 * `skl2onnx`
@@ -108,15 +128,15 @@ pip install psyke
 * `parameterized`
 
 Once installed, it is possible to create an extractor from a predictor 
-(e.g. Neural Network, Support Vector Machine, K-Nearest Neighbor, Random Forest, etc.)
-and from the dataset used to train the predictor.
+(e.g. Neural Network, Support Vector Machine, K-Nearest Neighbours, Random Forest, etc.)
+and from the data set used to train the predictor.
 
 > **Note:** the predictor must expose a method named `predict` to be properly used as an oracle.
 
 #### End users
 
 A brief example is presented in `demo.py` script in the `demo/` folder.
-Using `sklearn`'s Iris dataset we train a K-Nearest Neighbor to predict the correct output class.
+Using `sklearn`'s Iris data set we train a K-Nearest Neighbours to predict the correct output class.
 Before training, we make the dataset discrete.
 After that we create two different extractors: REAL and Trepan.
 We output the extracted theory for both extractors.
@@ -142,8 +162,8 @@ iris(PetalLength8, PetalWidth8, SepalLength8, SepalWidth8, setosa) :- true.
 ## Developers
 
 Working with PSyKE codebase requires a number of tools to be installed:
-* Python 3.9
-  + Python version greater than `3.9.x` are currently __not__ supported
+* Python 3.11
+  + Python version >= `3.12.x` are currently __not__ supported
 
 * JDK 11+ (please ensure the `JAVA_HOME` environment variable is properly configured)
 * Git 2.20+

psyke-1.0.4.dev10.dist-info/RECORD

@@ -0,0 +1,46 @@
+psyke/__init__.py,sha256=p8ssZXquoOZvdwNZgSSpyG94MRJbeph3KYiZuywBaIc,23317
+psyke/hypercubepredictor.py,sha256=Pg8F2R_NHrNgFHx92s32BorYHMVvaxpEh4GtCsoyB2U,4620
+psyke/clustering/__init__.py,sha256=LfLZY2UwHY9xlFT4SMGGbyFY5S6sMXndY-UMaJIJtd8,714
+psyke/clustering/utils.py,sha256=BqMPKJ-r6CdxXwyk-2AvkPV4DBnZF5WUNz2fKiXbhlw,1596
+psyke/clustering/cream/__init__.py,sha256=TtUd5IyfavSUZeSuSAr06ZftVhK30ZLZGUUfH3ZQG2w,2799
+psyke/clustering/exact/__init__.py,sha256=OMMxc_lIKHouZTpbLF7dt4dOA3chL4XFpjOCyc6GTTY,5545
+psyke/extraction/__init__.py,sha256=6wR6HA6lmgv1CCfi41pjQPPQoCghDcOJRNwK3lQh-Mc,903
+psyke/extraction/cart/CartPredictor.py,sha256=AA7g8P-SbuiXc-iqTgTe8naJi3rHMXs8_a_ti-v9pxU,5764
+psyke/extraction/cart/FairTree.py,sha256=mccoLDrSNy6iivqFZ23m33hxIB_kPXa3mNL1ukfb5Ls,7624
+psyke/extraction/cart/FairTreePredictor.py,sha256=7z4oLqflkRMqqVW_UIlrGsQrvROM4sXUfY7LPQJ662g,2321
+psyke/extraction/cart/__init__.py,sha256=SsjAJiL4n6q_GNR6H8PNfhTkAZ67Ka7NRvVRxCULBhQ,3191
+psyke/extraction/hypercubic/__init__.py,sha256=vQNUsauSPvtG5WgolPrX64KG8kAPoEhbad3uB9lXAUs,13163
+psyke/extraction/hypercubic/hypercube.py,sha256=Pz-F6RkAKLT5e86L29khqLjKTJ7k2TZszdRdxddVFtA,26275
+psyke/extraction/hypercubic/strategy.py,sha256=iod2mrDPZKavPFoHP_9sCOTaNeXIWGUyjhUKMSM5vZU,1843
+psyke/extraction/hypercubic/utils.py,sha256=D2FN5CCm_T3h23DmLFoTnIcFo7LvIq__ktl4hjUqkcA,1525
+psyke/extraction/hypercubic/cosmik/__init__.py,sha256=XQUvOtMFpR0vMHYtwIVl3G626HMqN8Clt6BqNm4nvFs,1880
+psyke/extraction/hypercubic/creepy/__init__.py,sha256=TfqB80sn7Ev7aAWealOnHZRpiDtHWX0f_v_dDHm_VXU,2060
+psyke/extraction/hypercubic/divine/__init__.py,sha256=ClO8CITKKXoo7nhlBJagR1yAachsxLHYQlqggl-9eGE,3665
+psyke/extraction/hypercubic/ginger/__init__.py,sha256=7G8H07d6PyIfRjcQjTQbe1WhwpHce_ky7Sy61JoxbqA,4713
+psyke/extraction/hypercubic/gridex/__init__.py,sha256=tPPLGRJ-7fCt-OB-qq6W7EV0hqEuQVUGlXs2yyABo98,3161
+psyke/extraction/hypercubic/gridrex/__init__.py,sha256=4ToRAI1ugNC8FyvE6U2Kne3AEXfXmM5nR3PfypqKmzs,637
+psyke/extraction/hypercubic/hex/__init__.py,sha256=553AZjOT9thfqDGtVDI6WtgYNex2Y6dg53cEyuf7Q80,4805
+psyke/extraction/hypercubic/iter/__init__.py,sha256=bb0neiPcNlyyr-OUUjgw4vdkehnAsoyJzVJ88jAHtQ8,10233
+psyke/extraction/real/__init__.py,sha256=zAE_syurDqmFiopD5oLeIs9bROiuXy06wxoHmVqAhCA,5836
+psyke/extraction/real/utils.py,sha256=4NNL15Eu7cmkG9b29GBP6CKgMTV1cmiJVS0k1MbWpIs,2148
+psyke/extraction/trepan/__init__.py,sha256=H8F_wpFLPcfyx2tgOOno8FwUomxfVxVl1vxlb0ClP1g,6931
+psyke/extraction/trepan/utils.py,sha256=iSUJ1ooNQT_VO1KfBZuIUeUsyUbGdQf_pSEE87vMeQg,2320
+psyke/genetic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+psyke/genetic/fgin/__init__.py,sha256=iGRJ_7SlC1AwgAhW1_h6V_yp8jjTvAePGp9ftAKkuSQ,3772
+psyke/genetic/gin/__init__.py,sha256=5zQT7iSkBJ9vTre0T2liv4cU1ZcXBZtJx8_fzrQlEvI,5820
+psyke/schema/__init__.py,sha256=axv4ejZY0ItUwrC9IXb_yAhaQL5f1vwvXXmaIAHJmt0,26063
+psyke/tuning/__init__.py,sha256=yd_ForFmHeYbtRXltY1fOa-mPJvpE6ijzg50M_8Sdxw,3649
+psyke/tuning/crash/__init__.py,sha256=zIHEF75EFy_mRIieqzP04qKLG3GLsSc_mYZHpPfkzxU,2623
+psyke/tuning/orchid/__init__.py,sha256=s64iABbteik27CrRPHSVHNZX25JKlDu7YYjhseOizxw,3618
+psyke/tuning/pedro/__init__.py,sha256=rIUqL-xjqrfCGSxhkGySsAS6AThAB_2tbUPFYTNla4A,6736
+psyke/utils/__init__.py,sha256=F-fgBT9CkthIwW8dDCuF5OoQDVMBNvIsZyvNqkgZNUA,1767
+psyke/utils/dataframe.py,sha256=cPbCl_paACCtO0twCiHKUcEKIYiT89WDwQ-f5I9oKrg,6841
+psyke/utils/logic.py,sha256=ioP25WMTYNYEzaRDNDe3kGNWqZ6DA_63t19d-ky_2kM,12227
+psyke/utils/metrics.py,sha256=Oo5BOonOSfo0qYsXWT5dmypZ7jiStByFC2MKEU0uMHg,2250
+psyke/utils/plot.py,sha256=dE8JJ6tQ0Ezosid-r2jqAisREjFe5LqExRzsVi5Ns-c,7785
+psyke/utils/sorted.py,sha256=C3CPW2JisND30BRk5c1sAAHs3Lb_wsRB2qZrYFuRnfM,678
+psyke-1.0.4.dev10.dist-info/licenses/LICENSE,sha256=G3mPaubObvkBXbsgTTeYGLk_pNEW8tc7HZr4u_wLEpU,11398
+psyke-1.0.4.dev10.dist-info/METADATA,sha256=BssGGNUQkhNHICOZfzespz2KsriQIzbynPQDg_3csbY,8747
+psyke-1.0.4.dev10.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+psyke-1.0.4.dev10.dist-info/top_level.txt,sha256=q1HglxOqqoIRukFtyis_ZNHczZg4gANRUPWkD7HAUTU,6
+psyke-1.0.4.dev10.dist-info/RECORD,,

{psyke-0.4.9.dev6.dist-info → psyke-1.0.4.dev10.dist-info}/WHEEL

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

{psyke-0.4.9.dev6.dist-info → psyke-1.0.4.dev10.dist-info/licenses}/LICENSE

@@ -186,7 +186,8 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2021 PIKA-lab / eXplanable AI
+   Copyright 2021, Matteo Magnini and contributors listed in
+   the CONTRIBUTORS file.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

psyke/extraction/cart/predictor.py

@@ -1,73 +0,0 @@
-from collections import Iterable
-from typing import Union, Any
-import numpy as np
-from sklearn.tree import DecisionTreeClassifier, DecisionTreeRegressor
-from psyke.schema import Value, LessThan, GreaterThan
-
-LeafConstraints = list[tuple[str, Value, bool]]
-LeafSequence = Iterable[tuple[LeafConstraints, Any]]
-
-
-class CartPredictor:
-    """
-    A wrapper for decision and regression trees of sklearn.
-    """
-
-    def __init__(self, predictor: Union[DecisionTreeClassifier, DecisionTreeRegressor] = DecisionTreeClassifier(),
-                 normalization=None):
-        self._predictor = predictor
-        self.normalization = normalization
-
-    def __get_constraints(self, nodes: Iterable[(int, bool)]) -> LeafConstraints:
-        thresholds = [self._predictor.tree_.threshold[i[0]] for i in nodes]
-        features = [self._predictor.feature_names_in_[self._predictor.tree_.feature[node[0]]] for node in nodes]
-        conditions = [node[1] for node in nodes]
-        if self.normalization is not None:
-            thresholds = [threshold * self.normalization[feature][1] + self.normalization[feature][0]
-                          for feature, threshold in zip(features, thresholds)]
-        return [(feature, LessThan(threshold) if condition else GreaterThan(threshold), condition)
-                for feature, condition, threshold in zip(features, conditions, thresholds)]
-
-    def __get_leaves(self) -> Iterable[int]:
-        return [i for i, (left_child, right_child) in enumerate(zip(
-            self._left_children, self._right_children
-        )) if left_child == -1 and right_child == -1]
-
-    def __get_prediction(self, node: int) -> Any:
-        if hasattr(self._predictor, 'classes_'):
-            return self._predictor.classes_[np.argmax(self._predictor.tree_.value[node])]
-        else:
-            return self._predictor.tree_.value[node]
-
-    def __path(self, node: int, path=[]) -> Iterable[(int, bool)]:
-        if node == 0:
-            return path
-        father = list(self._left_children if node in self._left_children else self._right_children).index(node)
-        return self.__path(father, [(father, node in self._left_children)] + path)
-
-    def __iter__(self) -> LeafSequence:
-        leaves = self.__get_leaves()
-        return ((self.__get_constraints(self.__path(i)), self.__get_prediction(i)) for i in leaves)
-
-    def predict(self, data) -> Iterable:
-        return self._predictor.predict(data)
-
-    @property
-    def predictor(self) -> Union[DecisionTreeClassifier, DecisionTreeRegressor]:
-        return self._predictor
-
-    @property
-    def n_leaves(self) -> int:
-        return len(list(self.__get_leaves()))
-
-    @property
-    def _left_children(self) -> list[int]:
-        return self._predictor.tree_.children_left
-
-    @property
-    def _right_children(self) -> list[int]:
-        return self._predictor.tree_.children_right
-
-    @predictor.setter
-    def predictor(self, predictor: Union[DecisionTreeClassifier, DecisionTreeRegressor]):
-        self._predictor = predictor

psyke-0.4.9.dev6.dist-info/RECORD

@@ -1,36 +0,0 @@
-psyke/__init__.py,sha256=0lT0Q_hItrdxZeiqOF0PvwrYOpyOxUmlOzO0MEBMOCk,14626
-psyke/clustering/__init__.py,sha256=Yz4vVM2CPSeZSlo7nLN9zZrFtkh6lMTh_0RU81_YljQ,486
-psyke/clustering/utils.py,sha256=S0YwCKyHVYp9qUAQVzCMrTwcQFPJ5TD14Jwn10DE-Z4,1616
-psyke/clustering/cream/__init__.py,sha256=YDlhlDfrBnop3-1GjEJeFYNlPM68YPhM9Kb7TA1psi8,2864
-psyke/clustering/exact/__init__.py,sha256=txIseVHlFMBWcDifMc9mFYdcnIi3W3n3SQ2H1WRfNUc,5066
-psyke/extraction/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-psyke/extraction/cart/__init__.py,sha256=jVDqOu7dWzzDxdbks4BaNbDU4RGgD-ukPbhfUAxHKxo,4126
-psyke/extraction/cart/predictor.py,sha256=2-2mv5fI0lTwwfTaEonxKh0ZUdhxuIEE6OP_rJxgmqc,3019
-psyke/extraction/hypercubic/__init__.py,sha256=OOH_rvu-dmQT7cJ5MG0xoSvvzS-JyyYJNu9BI0dIn4Y,6436
-psyke/extraction/hypercubic/hypercube.py,sha256=FQEiqZz7-OJIJ7Xvx4GBXNROBEWcaN9NvxQpEjw1D6k,16509
-psyke/extraction/hypercubic/strategy.py,sha256=X-roIsfcpJyMdo2px5JtbhP7-XE-zUNkaEK7XGXoWA8,1636
-psyke/extraction/hypercubic/utils.py,sha256=D2FN5CCm_T3h23DmLFoTnIcFo7LvIq__ktl4hjUqkcA,1525
-psyke/extraction/hypercubic/creepy/__init__.py,sha256=CjTWW8Pfcs5WlwsE7OBnA5uAwSY0CB8aZJM0mly6pbU,2196
-psyke/extraction/hypercubic/gridex/__init__.py,sha256=OP6J5q_UYLn1QW-A8SDq6bojfMTqISisVDDrgP2LFWU,5644
-psyke/extraction/hypercubic/gridrex/__init__.py,sha256=RtPJ5Nokcbk2H9pJAMvua3VzYOnT0HPakbPD4uAfEFk,562
-psyke/extraction/hypercubic/iter/__init__.py,sha256=b67CRB3jI9oYVYb5it_aQ3cNHQ3v5qDNA32Iejg3TjI,10098
-psyke/extraction/real/__init__.py,sha256=yNWbfijqop1xnE6OsM6spRn36jHjeA_dWkVVO8lT-CU,6406
-psyke/extraction/real/utils.py,sha256=eHGU-Y0inn_8jrk9lMcuRUKXpsTkI-s_myXSWz4bALQ,2190
-psyke/extraction/trepan/__init__.py,sha256=avdFLXeiCMTiFXwVw3vOIoiuqzj5mnEXdzY1-WM3Ia8,6663
-psyke/extraction/trepan/utils.py,sha256=iSUJ1ooNQT_VO1KfBZuIUeUsyUbGdQf_pSEE87vMeQg,2320
-psyke/schema/__init__.py,sha256=gOUWx3gYSkRehlJ5opK0Q16-Tv5fwSTl19k7kzIHALU,15760
-psyke/tuning/__init__.py,sha256=f3NS883R5RXinqd7EGEeb0kisY5SwSxAcvzbtLPdKG4,2886
-psyke/tuning/crash/__init__.py,sha256=EH129fDnYM3u-6DqqJAhlhETNdiBQ9LNPGGtOm30I_s,3450
-psyke/tuning/orchid/__init__.py,sha256=VD5EzdaDHxRcnCnhASeSXDOMILk5pNP5GHz8z9w7ar4,3455
-psyke/tuning/pedro/__init__.py,sha256=wY2VSw-ENXuFymctnGmkygUpqtmIyYFPoT_zHXynlLs,5555
-psyke/utils/__init__.py,sha256=F-fgBT9CkthIwW8dDCuF5OoQDVMBNvIsZyvNqkgZNUA,1767
-psyke/utils/dataframe.py,sha256=cPbCl_paACCtO0twCiHKUcEKIYiT89WDwQ-f5I9oKrg,6841
-psyke/utils/logic.py,sha256=DwFBcjB1lZpeY1QMfKPtPeoWOmI1VIX3dpX54nkR4WI,12284
-psyke/utils/metrics.py,sha256=Oo5BOonOSfo0qYsXWT5dmypZ7jiStByFC2MKEU0uMHg,2250
-psyke/utils/plot.py,sha256=YFdcPUUdJuOe48aDGAFGipP7cafDhu7zAZdxMqZj1wo,4352
-psyke/utils/sorted.py,sha256=C3CPW2JisND30BRk5c1sAAHs3Lb_wsRB2qZrYFuRnfM,678
-psyke-0.4.9.dev6.dist-info/LICENSE,sha256=KP9K6Hgezf_xdMFW7ORyKz9uA8Y8k52YJn292wcP-_E,11354
-psyke-0.4.9.dev6.dist-info/METADATA,sha256=-yVWBwlHePHnbwpl90ygCy_Z9Fe-OhFlnOUghvh-ct8,8119
-psyke-0.4.9.dev6.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-psyke-0.4.9.dev6.dist-info/top_level.txt,sha256=q1HglxOqqoIRukFtyis_ZNHczZg4gANRUPWkD7HAUTU,6
-psyke-0.4.9.dev6.dist-info/RECORD,,