woodtapper 0.0.6__tar.gz

woodtapper-0.0.6/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 artefactory
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

woodtapper-0.0.6/MANIFEST.in

@@ -0,0 +1,3 @@
+recursive-include woodtapper *.pyx
+recursive-include woodtapper *.pxd
+recursive-include woodtapper *.c

woodtapper-0.0.6/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: woodtapper
+Version: 0.0.6
+Summary: A Python toolbox for interpretable and explainable tree ensembles.
+Author: Abdoulaye SAKHO
+Author-email: Abdoulaye SAKHO <abdoulaye7020@gmail.com>, artefactory <abdoulaye.sakho@artefact.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/artefactory/woodtapper
+Project-URL: Repository, https://github.com/artefactory/woodtapper
+Keywords: woodtapper,interpretable ML,tree-based models,Cython
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Software Development
+Requires-Python: <3.13,>=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=2.3.1
+Requires-Dist: pandas>=2.3.0
+Requires-Dist: scikit-learn>=1.6.1
+Requires-Dist: matplotlib>=3.10.0
+Requires-Dist: ucimlrepo>=0.0.7
+Provides-Extra: dev
+Requires-Dist: pytest>=8.4.2; extra == "dev"
+Requires-Dist: pytest-cov>=7.0.0; extra == "dev"
+Requires-Dist: pre-commit>=4.3.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.6.1; extra == "docs"
+Requires-Dist: mkdocs-material>=9.6.22; extra == "docs"
+Requires-Dist: mkdocstrings-python>=1.18.2; extra == "docs"
+Dynamic: author
+Dynamic: license-file
+
+<div align="center">
+
+
+<picture>
+<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/artefactory/woodtapper/main/data/logos/logo_woodpecker_compressed.png">
+<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/artefactory/woodtapper/main/data/logos/logo_woodpecker_compressed_light.png" >
+<img src="https://raw.githubusercontent.com/artefactory/woodtapper/main/data/logos/logo_woodpecker_compressed_light.png" width="300">
+
+</picture>
+
+*User-friendly and scalable Python package for tapping decision tree ensembles*
+
+[![Linting , formatting, imports sorting: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+</div>
+
+WoodTapper is a Python toolbox  for interpretable and explainable tree ensembles learning, fully compatible with the scikit-learn API. WoodTapper enables seamless integration of interpretable rule extraction into existing machine learning workflows. In addition, it introduces an example-based explanation module that links predictions to a small set of representative samples.
+
+
+## 🌳 Installation
+
+**From TestPypi**:
+```bash
+pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ woodtapper
+```
+**From Source:**
+Clone the repository:
+```bash
+git clone git@github.com:artefactory/mgs-grf.git
+```
+
+And install the required packages into your environment (conda, mamba or pip):
+```bash
+pip install -r requirements.txt
+```
+
+Then run the following command from the repository root directory :
+```
+pip install -e .[dev]
+```
+
+## 🚀 How to use WoodTapper
+```python
+## RandomForestClassifier rules extraction
+from extract_rules.extractors import SirusClassifier
+
+SIRUS = SirusClassifier(n_estimators=1000,max_depth=2,
+                          quantile=10,p0=0.01, random_state=0)
+SIRUS.fit(X_train,y_train)
+y_pred_sirus = SIRUS.predict(X_test)
+```
+
+## 🙏 Acknowledgements
+
+This work was done through a partenership between **Artefact Research Center** and the **Laboratoire de Probabilités Statistiques et Modélisation** (LPSM) of Sorbonne University.
+
+<p align="center">
+  <a href="https://www.artefact.com/data-consulting-transformation/artefact-research-center/">
+    <img src="https://raw.githubusercontent.com/artefactory/woodtapper/main/data/logos/logo_arc.png" height="80" />
+  </a>
+  &emsp;
+  &emsp;
+  <a href="https://www.lpsm.paris/">
+    <img src="https://raw.githubusercontent.com/artefactory/woodtapper/main/data/logos//logo_LPSM.jpg" height="95" />
+  </a>
+</p>
+
+
+## 📜 Citation
+
+If you find the code usefull, please consider citing us :

woodtapper-0.0.6/README.md

@@ -0,0 +1,70 @@
+<div align="center">
+
+
+<picture>
+<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/artefactory/woodtapper/main/data/logos/logo_woodpecker_compressed.png">
+<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/artefactory/woodtapper/main/data/logos/logo_woodpecker_compressed_light.png" >
+<img src="https://raw.githubusercontent.com/artefactory/woodtapper/main/data/logos/logo_woodpecker_compressed_light.png" width="300">
+
+</picture>
+
+*User-friendly and scalable Python package for tapping decision tree ensembles*
+
+[![Linting , formatting, imports sorting: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+</div>
+
+WoodTapper is a Python toolbox  for interpretable and explainable tree ensembles learning, fully compatible with the scikit-learn API. WoodTapper enables seamless integration of interpretable rule extraction into existing machine learning workflows. In addition, it introduces an example-based explanation module that links predictions to a small set of representative samples.
+
+
+## 🌳 Installation
+
+**From TestPypi**:
+```bash
+pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ woodtapper
+```
+**From Source:**
+Clone the repository:
+```bash
+git clone git@github.com:artefactory/mgs-grf.git
+```
+
+And install the required packages into your environment (conda, mamba or pip):
+```bash
+pip install -r requirements.txt
+```
+
+Then run the following command from the repository root directory :
+```
+pip install -e .[dev]
+```
+
+## 🚀 How to use WoodTapper
+```python
+## RandomForestClassifier rules extraction
+from extract_rules.extractors import SirusClassifier
+
+SIRUS = SirusClassifier(n_estimators=1000,max_depth=2,
+                          quantile=10,p0=0.01, random_state=0)
+SIRUS.fit(X_train,y_train)
+y_pred_sirus = SIRUS.predict(X_test)
+```
+
+## 🙏 Acknowledgements
+
+This work was done through a partenership between **Artefact Research Center** and the **Laboratoire de Probabilités Statistiques et Modélisation** (LPSM) of Sorbonne University.
+
+<p align="center">
+  <a href="https://www.artefact.com/data-consulting-transformation/artefact-research-center/">
+    <img src="https://raw.githubusercontent.com/artefactory/woodtapper/main/data/logos/logo_arc.png" height="80" />
+  </a>
+  &emsp;
+  &emsp;
+  <a href="https://www.lpsm.paris/">
+    <img src="https://raw.githubusercontent.com/artefactory/woodtapper/main/data/logos//logo_LPSM.jpg" height="95" />
+  </a>
+</p>
+
+
+## 📜 Citation
+
+If you find the code usefull, please consider citing us :

woodtapper-0.0.6/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=78.1.1", "wheel", "Cython>=3.1.2","numpy>=2.3.1","scikit-learn>=1.6.1" ]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "woodtapper"
+authors = [
+    {name = "Abdoulaye SAKHO", email = "abdoulaye7020@gmail.com"},
+    {name = "artefactory", email = "abdoulaye.sakho@artefact.com"},
+]
+version = "0.0.6"
+description = "A Python toolbox for interpretable and explainable tree ensembles."
+readme = "README.md"
+license = "MIT"
+keywords = ["woodtapper", "interpretable ML", "tree-based models", "Cython"]
+classifiers = [
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Mathematics",
+    "Topic :: Software Development"
+]
+requires-python = ">=3.12,<3.13"
+dependencies = [
+    "numpy>=2.3.1",
+    "pandas>=2.3.0",
+    "scikit-learn>=1.6.1",
+    "matplotlib>=3.10.0",
+    "ucimlrepo>=0.0.7",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/artefactory/woodtapper"
+"Repository" = "https://github.com/artefactory/woodtapper"
+
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.4.2",
+    "pytest-cov>=7.0.0",
+    "pre-commit>=4.3.0"
+]
+docs = [
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.6.22",
+    "mkdocstrings-python>=1.18.2"
+]

woodtapper-0.0.6/realkd/__init__.py

@@ -0,0 +1 @@
+