matheel 0.3.6

Matheel: A CLI and Python package for source-code similarity detection.

Matheel

Matheel is a Python package and CLI for source-code similarity. It combines semantic embeddings, lexical similarity, chunking, preprocessing, and code evaluation metrics in one workflow.

Demos

• Hugging Face Space demo: buelfhood/matheel-framework
• Gradio Colab notebook: Open in Colab
• Examples Colab notebook: Open in Colab

Installation

Use Python 3.10 to 3.13. Installation can take some time.

Base install:

pip install matheel

Optional extras:

pip install "matheel[semantic]"
pip install "matheel[chunking]"
pip install "matheel[metrics]"
pip install "matheel[gradio]"
pip install "matheel[all]"

matheel[semantic] installs the supported semantic backends. matheel[chunking] installs Chonkie chunkers. matheel[metrics] installs optional code metric runtimes. matheel[gradio] installs the web app dependencies. matheel[all] installs all supported optional backends.

Compatibility extras remain available for narrower installs: sentence_transformers, model2vec, pylate, and chunking_code.

Examples that use semantic weights assume matheel[semantic] or matheel[all] is installed. See the usage guide for more install details.

Quick Start

matheel compare sample_pairs.zip \
  --model huggingface/CodeBERTa-small-v1 \
  --feature-weight semantic=0.7 \
  --feature-weight levenshtein=0.3 \
  --threshold 0.2 \
  --num 10

from matheel.similarity import calculate_similarity

score = calculate_similarity(
    "def add(a, b):\n    return a + b\n",
    "def add(x, y):\n    return x + y\n",
    feature_weights={"levenshtein": 1.0},
)
print(round(score, 4))

See the usage guide for archive, suite, chunking, embedding, and code-metric examples.

Docs

• Published docs: fahadebrahim.github.io/matheel
• Source docs: docs/index.md
• Usage guide: docs/usage.md
• Development: docs/development.md

Development

Install Matheel in editable mode with the development tools, then run the default checks:

python -m pip install -e ".[dev]"
python -m pytest
python -m ruff check .

More development and release checks are in the development docs.

License

This project is licensed under the MIT License.