sgtlearn 0.1.0__tar.gz

sgtlearn-0.1.0/.github/workflows/workflow.yml

@@ -0,0 +1,172 @@
+name: CI
+
+on:
+  push:
+    branches: ["**"]
+    tags: ["*"]
+  pull_request:
+    branches: ["**"]
+
+jobs:
+  cpp_build_and_test:
+    name: Build & Test C++
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository code
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y cmake ninja-build build-essential libopenblas-dev
+          pip install numpy
+
+      - name: Configure CMake
+        working-directory: cpp
+        run: cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DPython3_EXECUTABLE="$(which python3)"
+
+      - name: Build project
+        working-directory: cpp
+        run: cmake --build build
+
+      - name: Run unit tests
+        working-directory: cpp/build
+        run: ctest --output-on-failure
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+      - run: pip install ruff black
+      - run: ruff check sgtlearn/
+      - run: black --check sgtlearn/
+
+  python_layer_tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - name: Install scikit-learn 1.8+ for exact tree fidelity (3.11+)
+        if: matrix.python-version != '3.10'
+        run: pip install "scikit-learn>=1.8"
+      - run: pytest -v
+
+  build-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+      - run: pip install build
+      - run: python -m build
+
+  build_wheels:
+    name: Build wheels for ${{ matrix.os }}
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: [cpp_build_and_test, lint, python_layer_tests, build-check]
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, ubuntu-24.04-arm, windows-latest, windows-11-arm, macos-15-intel, macos-latest]
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          submodules: true
+          persist-credentials: false
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v3.4.1
+        with:
+          extras: uv
+        env:
+          CIBW_BUILD_FRONTEND: "build[uv]"
+          CIBW_BUILD: "cp311-* cp312-* cp313-* cp314-*"
+          CIBW_SKIP: "cp36-* cp37-* cp38-* cp39-* cp310-* pp*"
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.os }}
+          path: ./wheelhouse/*.whl
+
+  build_sdist:
+    name: Build source distribution
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: [cpp_build_and_test, lint, python_layer_tests, build-check]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          submodules: true
+          persist-credentials: false
+
+      - name: Build sdist
+        run: pipx run build --sdist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  publish-to-testpypi:
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: [build_wheels, build_sdist]
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/sgtlearn
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: wheels-*
+          merge-multiple: true
+          path: dist
+      - uses: actions/download-artifact@v4
+        with:
+          name: sdist
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+
+  publish-to-pypi:
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: [publish-to-testpypi]
+    name: Publish Python 🐍 distribution 📦 to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/sgtlearn
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: wheels-*
+          merge-multiple: true
+          path: dist
+      - uses: actions/download-artifact@v4
+        with:
+          name: sdist
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1

sgtlearn-0.1.0/.gitignore

@@ -0,0 +1,238 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+.DS_Store
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+.claude/
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+poetry.lock
+poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+
+.vscode/
+tempCodeRunnerFile.py
+
+
+# results/
+data/
+
+
+# cpp
+**/cmake-build-debug
+**/cmake-build-release
+# Accidental in-source CMake in cpp/ (always use -B cpp/cmake-build-release or similar)
+cpp/CMakeCache.txt
+cpp/CMakeFiles/
+cpp/_deps/
+cpp/Testing/
+cpp/.cmake/
+cpp/cmake_install.cmake
+cpp/CTestTestfile.cmake
+cpp/Makefile
+cpp/build.ninja
+
+
+sgt-learnold/
+CLAUDE.md
+docs/

sgtlearn-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nakul Upadhya, Eldan Cohen
+
+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.

sgtlearn-0.1.0/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.2
+Name: sgtlearn
+Version: 0.1.0
+Summary: Shape Generalized Trees learning library
+Author-Email: Nakul Upadhya <nakulupadhya1@gmail.com>, Joshua Lee <joshua.lee.9880@gmail.com>, Eldan Cohen <eldan.cohen@utoronto.ca>
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Requires-Dist: numpy>=1.20
+Requires-Dist: scikit-learn>=1.3
+Requires-Dist: joblib>=1.2
+Requires-Dist: matplotlib>=3.10.9
+Requires-Dist: seaborn>=0.13.2
+Requires-Dist: graphviz>=0.21
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: pybind11-stubgen; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Description-Content-Type: text/markdown
+
+# SGTLearn
+![sgt visualization](assets/SGT_Viz.png)
+
+`sgtlearn` is a Python package for learning [Shape Generalized Trees (SGTs)](https://neurips.cc/virtual/2025/loc/san-diego/poster/115950).
+
+- 🌳 **Shape Generalized Trees (SGTs):** A class of decision trees where each node applies a learnable, axis-aligned shape function to a feature for non-linear and interpretable splits.
+- 👁 **Interpretability:** Each node's shape function can be visualized directly.
+- ⚡ **ShapeCART Algorithm:** An efficient induction method for learning SGTs from data.
+- 🔀 **Extensions:**
+  - **Shape²GT (S²GT):** Bivariate shape functions for richer splits.
+  - **SGT<sub>K</sub>:** Multi-way branching generalization.
+  - **Shape²CART & ShapeCART<sub>K</sub>:** Algorithms for learning S²GTs and SGT<sub>K</sub>s.
+
+## Installation
+
+```bash
+pip install sgtlearn
+```
+
+Wheels are published for CPython 3.11–3.14 on Linux, macOS, and Windows
+(x86_64 + arm64); no compiler is needed for a binary install. To build from
+source instead, see [Developer Setup](#developer-setup).
+
+## Quick Start
+
+```python
+from sklearn.model_selection import train_test_split
+from sgtlearn import SGTClassifier, plot_tree, make_plus
+
+X, y = make_plus(n_samples=1500, grid=3, margin=0.07, random_state=42)
+
+X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.2, random_state=42)
+
+model = SGTClassifier(max_depth=4, random_state=42)
+model.fit(X_train, y_train)
+
+plot_tree(model, X=X_train)
+```
+
+## Developer Setup
+
+Use a **project-local virtual environment** (`.venv`) so Python, pytest, and
+scikit-learn stay isolated and reproducible. Pick one of the paths below
+(`uv` is recommended). All require **Python ≥ 3.11**.
+
+### Path 1 — `uv` (recommended)
+
+`uv` provisions a hermetic CPython and resolves the dev extras in one step:
+
+```bash
+uv sync --all-extras
+source .venv/bin/activate   # Windows: .venv\Scripts\activate
+```
+
+### Path 2 — `pip` + `venv` (editable)
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate   # Windows: .venv\Scripts\activate
+pip install -U pip
+pip install -e ".[dev]"
+```
+
+The editable install builds the C++ extensions via scikit-build-core and
+installs the `sgtlearn` package plus native modules into `.venv`.
+
+### Path 3 — `pip` non-editable (into the active environment)
+
+```bash
+pip install .
+pip install ".[dev]"   # dev extras (pytest, scikit-learn) only if needed
+```
+
+> **Anaconda users:** Do not bootstrap the venv from an Anaconda Python.
+> Anaconda ships a `libstdc++.so.6` that lags the symbol versions produced by
+> recent system compilers (gcc ≥ 13), so the install succeeds but
+> `import sgtlearn` fails with `ImportError: GLIBCXX_3.4.NN not found`. Use a
+> non-Anaconda Python — e.g. `uv venv --python 3.12 .venv` (downloads a
+> hermetic CPython), `pyenv`, or your distro's `python3`.
+
+## Build Workflow (scikit-build + CMake)
+
+`pip install .` drives this build path:
+
+1. `pyproject.toml` selects `scikit_build_core.build` as the backend.
+2. CMake is configured from `cpp/CMakeLists.txt`.
+3. Each file in `cpp/bindings/*.cpp` becomes one pybind11 module target.
+4. After each module is built, `pybind11-stubgen` generates a matching `.pyi`.
+5. The `.pyi` is generated and installed in the same location as the module `.so`.
+
+## C++ Folder Conventions
+
+- `cpp/include/sgtlearn/`: public headers for the core C++ API.
+- `cpp/src/`: internal C++ implementation for the core library.
+- `cpp/bindings/`: pybind11 binding entrypoints; one `.cpp` file maps to one Python extension module.
+- `cpp/tests/`: C++ unit tests consumed by the `cpp_tests` executable target.
+
+## CMake Targets
+
+- `sgtlearn_core` (static library): shared C++ logic used by Python modules and tests.
+- `<module_name>` (pybind11 module, one per file in `cpp/bindings/`): compiled extension modules installed into the package.
+- `cpp_tests` (Catch2 executable): optional C++ test target, controlled by:
+  - `-DSGTLEARN_BUILD_TESTS=ON` (build C++ tests)
+  - `-DSGTLEARN_BUILD_TESTS=OFF` (default for `pip install`; the CMake option itself defaults to `ON`, but `pyproject.toml` overrides this so wheels don't ship test binaries)
+
+### Overriding CMake options from `pip`
+
+Example (build C++ tests for one install):
+
+```bash
+pip install . --config-settings=cmake.args="-DSGTLEARN_BUILD_TESTS=ON"
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Contributing
+
+Contributions are welcome. Please feel free to submit a pull request.
+
+## Citation
+For the canonical code base for the paper "Empowering Decision Trees via Shape Function Branching", please refer to https://github.com/optimal-uoft/Empowering-DTs-via-Shape-Functions. 
+
+If you use this package in your research, please cite:
+
+```text
+@article{upadhya2026empowering,
+  title={Empowering Decision Trees via Shape Function Branching},
+  author={Upadhya, Nakul and Cohen, Eldan},
+  journal={Advances in Neural Information Processing Systems},
+  volume={38},
+  pages={122263--122308},
+  year={2026}
+}
+```
+
+Additionally, check out our other works on our [lab website](https://optimal.mie.utoronto.ca/).