psyke 1.0.4.dev1__tar.gz → 1.0.4.dev3__tar.gz

{psyke-1.0.4.dev1/psyke.egg-info → psyke-1.0.4.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: psyke
-Version: 1.0.4.dev1
+Version: 1.0.4.dev3
 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
@@ -47,16 +47,24 @@ Dynamic: summary
 
 ![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.
@@ -105,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`
@@ -122,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.
@@ -157,7 +163,7 @@ iris(PetalLength8, PetalWidth8, SepalLength8, SepalWidth8, setosa) :- true.
 
 Working with PSyKE codebase requires a number of tools to be installed:
 * Python 3.11
-  + Python version greater than `3.11.x` are currently __not__ supported
+  + 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.dev1 → psyke-1.0.4.dev3}/README.md

@@ -2,16 +2,24 @@
 
 ![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.
@@ -60,16 +68,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`
@@ -77,15 +83,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.
@@ -112,7 +118,7 @@ iris(PetalLength8, PetalWidth8, SepalLength8, SepalWidth8, setosa) :- true.
 
 Working with PSyKE codebase requires a number of tools to be installed:
 * Python 3.11
-  + Python version greater than `3.11.x` are currently __not__ supported
+  + 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.dev3/VERSION

@@ -0,0 +1 @@
+1.0.4.dev3

{psyke-1.0.4.dev1 → psyke-1.0.4.dev3/psyke.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: psyke
-Version: 1.0.4.dev1
+Version: 1.0.4.dev3
 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
@@ -47,16 +47,24 @@ Dynamic: summary
 
 ![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.
@@ -105,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`
@@ -122,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.
@@ -157,7 +163,7 @@ iris(PetalLength8, PetalWidth8, SepalLength8, SepalWidth8, setosa) :- true.
 
 Working with PSyKE codebase requires a number of tools to be installed:
 * Python 3.11
-  + Python version greater than `3.11.x` are currently __not__ supported
+  + 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.dev1/VERSION

@@ -1 +0,0 @@
-1.0.4.dev1