IMoTE 0.0.0__tar.gz

imote-0.0.0/IMoTE.egg-info/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: IMoTE
+Version: 0.0.0
+Summary: IMoTE: Interactive MOdel Tree Explorer, an interactive app to visualise and explore linear model trees
+Author-email: Flor Debois <flor.debois@uantwerpen.be>, Thomas Servotte <thomas.servotte@uantwerpen.be>, Jakob Raymaekers <jakob.raymaekers@uantwerpen.be>, Tim Verdonck <tim.verdonck@uantwerpen.be>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/STAN-UAntwerp/IMoTE
+Project-URL: Documentation, https://stan-uantwerp.github.io/IMoTE/
+Project-URL: Repository, https://github.com/STAN-UAntwerp/IMoTE
+Project-URL: Issues, https://github.com/STAN-UAntwerp/IMoTE/issues
+Keywords: linear model trees,visualization,interpretability,machine learning,decision trees,regression
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Framework :: Dash
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dash>=4.2
+Requires-Dist: dash-bootstrap-components>=1.6
+Requires-Dist: dash-cytoscape>=1.0
+Requires-Dist: flask>=3.0
+Requires-Dist: numpy>=1.21
+Requires-Dist: pandas>=1.3
+Requires-Dist: matplotlib>=3.6
+Requires-Dist: seaborn>=0.13
+Requires-Dist: pmlb>=1.0
+Requires-Dist: fast-model-trees>=0.0.5
+Requires-Dist: m5py>=0.3.3
+Requires-Dist: scikit-learn<1.9,>=1.3
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs<2,>=1.6; extra == "docs"
+Requires-Dist: mkdocs-material>=9.5; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.26; extra == "docs"
+Dynamic: license-file
+
+# IMoTE: Interactive MOdel Tree Explorer
+
+**IMoTE** is an interactive app to fit, visualise and explore **linear model trees** for regression.
+Inspect the tree as an interactive graph, see the linear model and data behind every node, and trace a single
+data point through the tree to understand its prediction.
+
+![IMoTE: the tree graph with the interaction cards on the right](https://raw.githubusercontent.com/STAN-UAntwerp/IMoTE/main/docs/assets/screenshots/app-overview.png)
+
+## Overview
+
+IMoTE supports two linear model tree algorithms out of the box:
+
+- **PILOT** (*PIecewise Linear Organic Tree*): a fast linear model tree algorithm, using the
+  [fast-model-trees](https://github.com/STAN-UAntwerp/fast-model-trees) implementation.
+- **M5**: the classic model tree algorithm, using [m5py](https://pypi.org/project/m5py/).
+
+Trees fitted with other tools can be loaded by writing an **adapter**. A partykit (R) adapter is included as an example.
+
+## Installation
+
+```bash
+pip install imote
+```
+
+IMoTE needs Python 3.10 or newer.
+
+## Quick start
+
+### Start the app
+
+```bash
+imote
+```
+
+Then open the address shown in the terminal (by default <http://127.0.0.1:8050>). From the **New Tree** card you can
+fit PILOT or M5 on a built-in dataset or on your own CSV file.
+
+IMoTE stores saved trees, uploaded datasets and generated plots in `~/.imote`. Set the `IMOTE_HOME` environment
+variable to use another folder.
+
+## Documentation
+
+The full documentation, with a guide to every part of the interface and how to write your own adapter, is at
+<https://stan-uantwerp.github.io/IMoTE/>.
+
+## Papers
+
+- **PILOT**: Raymaekers, J., Rousseeuw, P. J., Verdonck, T., & Yao, R. (2024). Fast linear model trees by PILOT.
+  *Machine Learning*, 113(9), 6561-6610. <https://doi.org/10.1007/s10994-024-06590-3>
+- **M5**: Quinlan, J. R. (1992). Learning with continuous classes. In *5th Australian Joint Conference on Artificial
+  Intelligence* (Vol. 92, pp. 343-348).
+
+## Development
+
+```bash
+git clone https://github.com/STAN-UAntwerp/IMoTE
+cd IMoTE
+pip install -e ".[dev]"   # IMoTE in editable mode, plus pytest, build and twine
+python -m imote.app       # start the app in Dash debug mode, it reloads on code changes
+```
+
+To work on the documentation: `pip install -e ".[docs]"`, then `mkdocs serve`.
+
+## License
+
+MIT, see [LICENSE](https://github.com/STAN-UAntwerp/IMoTE/blob/main/LICENSE).

imote-0.0.0/IMoTE.egg-info/SOURCES.txt

@@ -0,0 +1,94 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+pytest.ini
+IMoTE.egg-info/PKG-INFO
+IMoTE.egg-info/SOURCES.txt
+IMoTE.egg-info/dependency_links.txt
+IMoTE.egg-info/entry_points.txt
+IMoTE.egg-info/requires.txt
+IMoTE.egg-info/scm_file_list.json
+IMoTE.egg-info/scm_version.json
+IMoTE.egg-info/top_level.txt
+imote/__init__.py
+imote/app.py
+imote/benchmark_info.py
+imote/config.py
+imote/ids.py
+imote/adapters/__init__.py
+imote/adapters/adapter_utils.py
+imote/adapters/base_adapter.py
+imote/adapters/build_root_node_m5.py
+imote/adapters/m5_adapter.py
+imote/adapters/partykit_adapter.py
+imote/adapters/pilot_adapter.py
+imote/callbacks/__init__.py
+imote/callbacks/a_tree_info_callbacks.py
+imote/callbacks/b_node_callbacks.py
+imote/callbacks/c_new_tree_callbacks.py
+imote/callbacks/d_edit_tree_callbacks.py
+imote/callbacks/e_layout_callbacks.py
+imote/callbacks/f_highlight_callbacks.py
+imote/callbacks/g_elements_callbacks.py
+imote/components/__init__.py
+imote/components/cytoscape_graph.py
+imote/components/stores.py
+imote/components/cards/__init__.py
+imote/components/cards/a_tree_info_card.py
+imote/components/cards/b_node_info_card.py
+imote/components/cards/bb_node_plot_settings_card.py
+imote/components/cards/c_new_tree_card.py
+imote/components/cards/d_edit_tree_card.py
+imote/components/cards/e_layout_card.py
+imote/components/cards/f_highlight_card.py
+imote/data/initial_tree.pkl
+imote/dataset/__init__.py
+imote/dataset/dataset.py
+imote/dataset/dataset_registry.py
+imote/node_metrics/__init__.py
+imote/node_metrics/node_metric.py
+imote/nodes/__init__.py
+imote/nodes/base_node.py
+imote/nodes/collapsed_node.py
+imote/nodes/combined_lin_node.py
+imote/nodes/internal_node.py
+imote/nodes/leaf_node.py
+imote/nodes/node_model.py
+imote/nodes/none_node.py
+imote/nodes/split_node.py
+imote/pages/__init__.py
+imote/pages/explain_page.py
+imote/pages/tree_view_page.py
+imote/plots/__init__.py
+imote/plots/predsplot.py
+imote/plots/predsplot2.py
+imote/plots/regplot.py
+imote/viz_tree/__init__.py
+imote/viz_tree/contributions.py
+imote/viz_tree/viz_tree.py
+imote/viz_tree/viz_tree_cytoscape.py
+tests/__init__.py
+tests/conftest.py
+tests/helpers.py
+tests/adapters/__init__.py
+tests/adapters/test_m5_adapter.py
+tests/adapters/test_partykit_adapter.py
+tests/adapters/test_pilot_adapter.py
+tests/dataset/__init__.py
+tests/dataset/test_dataset.py
+tests/node_metrics/__init__.py
+tests/node_metrics/test_node_metric.py
+tests/nodes/__init__.py
+tests/nodes/conftest.py
+tests/nodes/test_collapsed_node.py
+tests/nodes/test_combined_lin_node.py
+tests/nodes/test_internal_node.py
+tests/nodes/test_leaf_node.py
+tests/nodes/test_node_model.py
+tests/nodes/test_none_node.py
+tests/nodes/test_split_node.py
+tests/viz_tree/__init__.py
+tests/viz_tree/test_contributions.py
+tests/viz_tree/test_viz_tree.py
+tests/viz_tree/test_viz_tree_cytoscape.py

imote-0.0.0/IMoTE.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

imote-0.0.0/IMoTE.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+imote = imote.app:main

imote-0.0.0/IMoTE.egg-info/requires.txt

@@ -0,0 +1,22 @@
+dash>=4.2
+dash-bootstrap-components>=1.6
+dash-cytoscape>=1.0
+flask>=3.0
+numpy>=1.21
+pandas>=1.3
+matplotlib>=3.6
+seaborn>=0.13
+pmlb>=1.0
+fast-model-trees>=0.0.5
+m5py>=0.3.3
+scikit-learn<1.9,>=1.3
+
+[dev]
+pytest>=7
+build
+twine
+
+[docs]
+mkdocs<2,>=1.6
+mkdocs-material>=9.5
+mkdocstrings[python]>=0.26

imote-0.0.0/IMoTE.egg-info/scm_file_list.json

@@ -0,0 +1,141 @@
+{
+  "files": [
+    ".github/workflows/docs.yml",
+    ".github/workflows/publish.yml",
+    ".github/workflows/tests.yml",
+    ".gitignore",
+    "LICENSE",
+    "MANIFEST.in",
+    "README.md",
+    "docs/adapter/adapter_overview.md",
+    "docs/adapter/partykit_example.md",
+    "docs/assets/screenshots/a-tree-info.png",
+    "docs/assets/screenshots/app-overview-annotated.png",
+    "docs/assets/screenshots/app-overview.png",
+    "docs/assets/screenshots/b-node-info-pred.png",
+    "docs/assets/screenshots/b-node-info-reg.png",
+    "docs/assets/screenshots/b-node-info.png",
+    "docs/assets/screenshots/c-new-tree.png",
+    "docs/assets/screenshots/csv_upload.png",
+    "docs/assets/screenshots/d-edit-tree.png",
+    "docs/assets/screenshots/e-layout.png",
+    "docs/assets/screenshots/f-highlight.png",
+    "docs/assets/screenshots/gallery-collapsed.png",
+    "docs/assets/screenshots/gallery-highlight-path-plots.png",
+    "docs/assets/screenshots/gallery-large.png",
+    "docs/assets/screenshots/gallery-m5.png",
+    "docs/assets/screenshots/gallery-show-all-node.png",
+    "docs/assets/screenshots/gallery-subtree-highlight.png",
+    "docs/assets/stylesheets/custom.css",
+    "docs/assets/stylesheets/custom_api.css",
+    "docs/gallery.md",
+    "docs/index.md",
+    "docs/reference/adapters/base_adapter.md",
+    "docs/reference/adapters/partykit_adapter.md",
+    "docs/reference/nodes/base_node.md",
+    "docs/reference/nodes/collapsed_node.md",
+    "docs/reference/nodes/combined_lin_node.md",
+    "docs/reference/nodes/internal_node.md",
+    "docs/reference/nodes/leaf_node.md",
+    "docs/reference/nodes/node_model.md",
+    "docs/reference/nodes/none_node.md",
+    "docs/reference/nodes/split_node.md",
+    "docs/reference/reference_overview.md",
+    "docs/reference/viz_tree.md",
+    "docs/user-guide/a-tree-info.md",
+    "docs/user-guide/b-node-info.md",
+    "docs/user-guide/c-new-tree.md",
+    "docs/user-guide/d-edit-tree.md",
+    "docs/user-guide/e-layout.md",
+    "docs/user-guide/f-highlight.md",
+    "docs/user-guide/interface-overview.md",
+    "experimental/__init__.py",
+    "experimental/beeswarm.py",
+    "experimental/colors.py",
+    "experimental/contribution_plots.py",
+    "imote/__init__.py",
+    "imote/adapters/__init__.py",
+    "imote/adapters/adapter_utils.py",
+    "imote/adapters/base_adapter.py",
+    "imote/adapters/build_root_node_m5.py",
+    "imote/adapters/m5_adapter.py",
+    "imote/adapters/partykit_adapter.py",
+    "imote/adapters/pilot_adapter.py",
+    "imote/app.py",
+    "imote/benchmark_info.py",
+    "imote/callbacks/__init__.py",
+    "imote/callbacks/a_tree_info_callbacks.py",
+    "imote/callbacks/b_node_callbacks.py",
+    "imote/callbacks/c_new_tree_callbacks.py",
+    "imote/callbacks/d_edit_tree_callbacks.py",
+    "imote/callbacks/e_layout_callbacks.py",
+    "imote/callbacks/f_highlight_callbacks.py",
+    "imote/callbacks/g_elements_callbacks.py",
+    "imote/components/__init__.py",
+    "imote/components/cards/__init__.py",
+    "imote/components/cards/a_tree_info_card.py",
+    "imote/components/cards/b_node_info_card.py",
+    "imote/components/cards/bb_node_plot_settings_card.py",
+    "imote/components/cards/c_new_tree_card.py",
+    "imote/components/cards/d_edit_tree_card.py",
+    "imote/components/cards/e_layout_card.py",
+    "imote/components/cards/f_highlight_card.py",
+    "imote/components/cytoscape_graph.py",
+    "imote/components/stores.py",
+    "imote/config.py",
+    "imote/data/initial_tree.pkl",
+    "imote/dataset/__init__.py",
+    "imote/dataset/dataset.py",
+    "imote/dataset/dataset_registry.py",
+    "imote/ids.py",
+    "imote/node_metrics/__init__.py",
+    "imote/node_metrics/node_metric.py",
+    "imote/nodes/__init__.py",
+    "imote/nodes/base_node.py",
+    "imote/nodes/collapsed_node.py",
+    "imote/nodes/combined_lin_node.py",
+    "imote/nodes/internal_node.py",
+    "imote/nodes/leaf_node.py",
+    "imote/nodes/node_model.py",
+    "imote/nodes/none_node.py",
+    "imote/nodes/split_node.py",
+    "imote/pages/__init__.py",
+    "imote/pages/explain_page.py",
+    "imote/pages/tree_view_page.py",
+    "imote/plots/__init__.py",
+    "imote/plots/predsplot.py",
+    "imote/plots/predsplot2.py",
+    "imote/plots/regplot.py",
+    "imote/viz_tree/__init__.py",
+    "imote/viz_tree/contributions.py",
+    "imote/viz_tree/viz_tree.py",
+    "imote/viz_tree/viz_tree_cytoscape.py",
+    "mkdocs.yml",
+    "pyproject.toml",
+    "pytest.ini",
+    "tests/__init__.py",
+    "tests/adapters/__init__.py",
+    "tests/adapters/test_m5_adapter.py",
+    "tests/adapters/test_partykit_adapter.py",
+    "tests/adapters/test_pilot_adapter.py",
+    "tests/conftest.py",
+    "tests/dataset/__init__.py",
+    "tests/dataset/test_dataset.py",
+    "tests/helpers.py",
+    "tests/node_metrics/__init__.py",
+    "tests/node_metrics/test_node_metric.py",
+    "tests/nodes/__init__.py",
+    "tests/nodes/conftest.py",
+    "tests/nodes/test_collapsed_node.py",
+    "tests/nodes/test_combined_lin_node.py",
+    "tests/nodes/test_internal_node.py",
+    "tests/nodes/test_leaf_node.py",
+    "tests/nodes/test_node_model.py",
+    "tests/nodes/test_none_node.py",
+    "tests/nodes/test_split_node.py",
+    "tests/viz_tree/__init__.py",
+    "tests/viz_tree/test_contributions.py",
+    "tests/viz_tree/test_viz_tree.py",
+    "tests/viz_tree/test_viz_tree_cytoscape.py"
+  ]
+}

imote-0.0.0/IMoTE.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.0.0",
+  "distance": 0,
+  "node": "gbbdca2696f7c54d0bf4655df980933f8ff238769",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-10-07"
+}

imote-0.0.0/IMoTE.egg-info/top_level.txt

@@ -0,0 +1 @@
+imote

imote-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 STAN-UAntwerp
+
+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.

imote-0.0.0/MANIFEST.in

@@ -0,0 +1,5 @@
+# setuptools-scm adds every git-tracked file to the sdist, leave out what users don't need
+prune docs
+prune experimental
+prune .github
+exclude mkdocs.yml .gitignore

imote-0.0.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: IMoTE
+Version: 0.0.0
+Summary: IMoTE: Interactive MOdel Tree Explorer, an interactive app to visualise and explore linear model trees
+Author-email: Flor Debois <flor.debois@uantwerpen.be>, Thomas Servotte <thomas.servotte@uantwerpen.be>, Jakob Raymaekers <jakob.raymaekers@uantwerpen.be>, Tim Verdonck <tim.verdonck@uantwerpen.be>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/STAN-UAntwerp/IMoTE
+Project-URL: Documentation, https://stan-uantwerp.github.io/IMoTE/
+Project-URL: Repository, https://github.com/STAN-UAntwerp/IMoTE
+Project-URL: Issues, https://github.com/STAN-UAntwerp/IMoTE/issues
+Keywords: linear model trees,visualization,interpretability,machine learning,decision trees,regression
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Framework :: Dash
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dash>=4.2
+Requires-Dist: dash-bootstrap-components>=1.6
+Requires-Dist: dash-cytoscape>=1.0
+Requires-Dist: flask>=3.0
+Requires-Dist: numpy>=1.21
+Requires-Dist: pandas>=1.3
+Requires-Dist: matplotlib>=3.6
+Requires-Dist: seaborn>=0.13
+Requires-Dist: pmlb>=1.0
+Requires-Dist: fast-model-trees>=0.0.5
+Requires-Dist: m5py>=0.3.3
+Requires-Dist: scikit-learn<1.9,>=1.3
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs<2,>=1.6; extra == "docs"
+Requires-Dist: mkdocs-material>=9.5; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.26; extra == "docs"
+Dynamic: license-file
+
+# IMoTE: Interactive MOdel Tree Explorer
+
+**IMoTE** is an interactive app to fit, visualise and explore **linear model trees** for regression.
+Inspect the tree as an interactive graph, see the linear model and data behind every node, and trace a single
+data point through the tree to understand its prediction.
+
+![IMoTE: the tree graph with the interaction cards on the right](https://raw.githubusercontent.com/STAN-UAntwerp/IMoTE/main/docs/assets/screenshots/app-overview.png)
+
+## Overview
+
+IMoTE supports two linear model tree algorithms out of the box:
+
+- **PILOT** (*PIecewise Linear Organic Tree*): a fast linear model tree algorithm, using the
+  [fast-model-trees](https://github.com/STAN-UAntwerp/fast-model-trees) implementation.
+- **M5**: the classic model tree algorithm, using [m5py](https://pypi.org/project/m5py/).
+
+Trees fitted with other tools can be loaded by writing an **adapter**. A partykit (R) adapter is included as an example.
+
+## Installation
+
+```bash
+pip install imote
+```
+
+IMoTE needs Python 3.10 or newer.
+
+## Quick start
+
+### Start the app
+
+```bash
+imote
+```
+
+Then open the address shown in the terminal (by default <http://127.0.0.1:8050>). From the **New Tree** card you can
+fit PILOT or M5 on a built-in dataset or on your own CSV file.
+
+IMoTE stores saved trees, uploaded datasets and generated plots in `~/.imote`. Set the `IMOTE_HOME` environment
+variable to use another folder.
+
+## Documentation
+
+The full documentation, with a guide to every part of the interface and how to write your own adapter, is at
+<https://stan-uantwerp.github.io/IMoTE/>.
+
+## Papers
+
+- **PILOT**: Raymaekers, J., Rousseeuw, P. J., Verdonck, T., & Yao, R. (2024). Fast linear model trees by PILOT.
+  *Machine Learning*, 113(9), 6561-6610. <https://doi.org/10.1007/s10994-024-06590-3>
+- **M5**: Quinlan, J. R. (1992). Learning with continuous classes. In *5th Australian Joint Conference on Artificial
+  Intelligence* (Vol. 92, pp. 343-348).
+
+## Development
+
+```bash
+git clone https://github.com/STAN-UAntwerp/IMoTE
+cd IMoTE
+pip install -e ".[dev]"   # IMoTE in editable mode, plus pytest, build and twine
+python -m imote.app       # start the app in Dash debug mode, it reloads on code changes
+```
+
+To work on the documentation: `pip install -e ".[docs]"`, then `mkdocs serve`.
+
+## License
+
+MIT, see [LICENSE](https://github.com/STAN-UAntwerp/IMoTE/blob/main/LICENSE).

imote-0.0.0/README.md

@@ -0,0 +1,66 @@
+# IMoTE: Interactive MOdel Tree Explorer
+
+**IMoTE** is an interactive app to fit, visualise and explore **linear model trees** for regression.
+Inspect the tree as an interactive graph, see the linear model and data behind every node, and trace a single
+data point through the tree to understand its prediction.
+
+![IMoTE: the tree graph with the interaction cards on the right](https://raw.githubusercontent.com/STAN-UAntwerp/IMoTE/main/docs/assets/screenshots/app-overview.png)
+
+## Overview
+
+IMoTE supports two linear model tree algorithms out of the box:
+
+- **PILOT** (*PIecewise Linear Organic Tree*): a fast linear model tree algorithm, using the
+  [fast-model-trees](https://github.com/STAN-UAntwerp/fast-model-trees) implementation.
+- **M5**: the classic model tree algorithm, using [m5py](https://pypi.org/project/m5py/).
+
+Trees fitted with other tools can be loaded by writing an **adapter**. A partykit (R) adapter is included as an example.
+
+## Installation
+
+```bash
+pip install imote
+```
+
+IMoTE needs Python 3.10 or newer.
+
+## Quick start
+
+### Start the app
+
+```bash
+imote
+```
+
+Then open the address shown in the terminal (by default <http://127.0.0.1:8050>). From the **New Tree** card you can
+fit PILOT or M5 on a built-in dataset or on your own CSV file.
+
+IMoTE stores saved trees, uploaded datasets and generated plots in `~/.imote`. Set the `IMOTE_HOME` environment
+variable to use another folder.
+
+## Documentation
+
+The full documentation, with a guide to every part of the interface and how to write your own adapter, is at
+<https://stan-uantwerp.github.io/IMoTE/>.
+
+## Papers
+
+- **PILOT**: Raymaekers, J., Rousseeuw, P. J., Verdonck, T., & Yao, R. (2024). Fast linear model trees by PILOT.
+  *Machine Learning*, 113(9), 6561-6610. <https://doi.org/10.1007/s10994-024-06590-3>
+- **M5**: Quinlan, J. R. (1992). Learning with continuous classes. In *5th Australian Joint Conference on Artificial
+  Intelligence* (Vol. 92, pp. 343-348).
+
+## Development
+
+```bash
+git clone https://github.com/STAN-UAntwerp/IMoTE
+cd IMoTE
+pip install -e ".[dev]"   # IMoTE in editable mode, plus pytest, build and twine
+python -m imote.app       # start the app in Dash debug mode, it reloads on code changes
+```
+
+To work on the documentation: `pip install -e ".[docs]"`, then `mkdocs serve`.
+
+## License
+
+MIT, see [LICENSE](https://github.com/STAN-UAntwerp/IMoTE/blob/main/LICENSE).

imote-0.0.0/imote/__init__.py

@@ -0,0 +1,28 @@
+"""IMoTE: Interactive MOdel Tree Explorer."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("imote")  # set from the git tag by setuptools-scm at install time
+except PackageNotFoundError:  # running from a source tree that was never pip installed
+    __version__ = "0+unknown"
+
+from imote.adapters import M5Adapter, PartyKitAdapter, PilotAdapter
+from imote.adapters.base_adapter import ADAPTERS_REGISTRY, BaseAdapter, register_adapter
+from imote.dataset.dataset import Dataset
+from imote.node_metrics.node_metric import NODE_METRICS_REGISTRY, BaseNodeMetric, register_metric
+from imote.viz_tree.viz_tree import VizTree
+
+__all__ = [
+    "VizTree",
+    "Dataset",
+    "BaseAdapter",
+    "register_adapter",
+    "ADAPTERS_REGISTRY",
+    "PilotAdapter",
+    "M5Adapter",
+    "PartyKitAdapter",
+    "BaseNodeMetric",
+    "register_metric",
+    "NODE_METRICS_REGISTRY",
+]

imote-0.0.0/imote/adapters/__init__.py

@@ -0,0 +1,3 @@
+from .pilot_adapter import PilotAdapter
+from .m5_adapter import M5Adapter
+from .partykit_adapter import PartyKitAdapter

imote-0.0.0/imote/adapters/adapter_utils.py

@@ -0,0 +1,15 @@
+import numpy as np
+
+def split_by_threshold(X_train, current_indices, pivot_idx, pivot_value):
+    mask = X_train[current_indices, pivot_idx] <= pivot_value
+    return _apply_mask(current_indices, mask)
+
+def split_by_categories(X_train, current_indices, pivot_idx, left_categories):
+    mask = np.isin(X_train[current_indices, pivot_idx], left_categories)
+    return _apply_mask(current_indices, mask)
+
+def _apply_mask(current_indices, mask):
+    left_indices, right_indices = current_indices.copy(), current_indices.copy()
+    left_indices[current_indices] = mask
+    right_indices[current_indices] = ~mask
+    return left_indices, right_indices