Skip to main content

TabuLLM

Tests Docs Coverage PyPI version Python versions License

Python package for feature extraction and interpretation of text columns in tabular data using large language models.

Overview

TabuLLM integrates LLM-based text embeddings into scikit-learn pipelines for tabular datasets containing text columns. Built on LangChain and scikit-learn, it provides sklearn-compatible transformers for embedding, dimensionality reduction, and cluster interpretation.

Paper

TabuLLM is described in our SoftwareX paper:

Sharabiani, M.T.A., Bottle, A., and Mahani, A.S. (2026). TabuLLM: Feature extraction and interpretation of text columns in tabular data using large language models. SoftwareX, 35, 102810. https://doi.org/10.1016/j.softx.2026.102810

Installation

pip install tabullm

Core Components

TextColumnTransformer - Wraps LangChain embedding models (OpenAI, Anthropic, HuggingFace, etc.) with a sklearn interface. Handles multiple text columns with configurable concatenation and optional L2 normalization (normalize=True). Use estimate_tokens() to preview API cost before embedding.

GMMFeatureExtractor - Extends sklearn's GaussianMixture with a transform() method that returns per-cluster log-joint features $\log p(\mathbf{x}, c_k)$ — the quantity the GMM maximises for hard assignment — enabling use in sklearn pipelines. An optional include_log_density parameter appends the marginal log-density as an explicit outlier score. A companion assignment_confidence_stats() method returns per-observation cluster quality diagnostics (max_posterior, entropy, log_joint_margin, log_density).

ClusterExplainer - Generates natural language cluster descriptions using LLMs with automatic recursive summarization that scales to arbitrarily large datasets. Supports:

  • Cost preview (preview=True) before LLM calls
  • Optional outcome-based statistical testing (y) to characterize which clusters associate with a target variable
  • Per-observation covariates (observation_stats) — e.g., from assignment_confidence_stats() — appended to the association table
  • A synthesis step (synthesize=True) that produces a coherent interpretive narrative across all cluster results
  • An outcome label (y_label) used only in the synthesis prompt; cluster descriptions are generated without knowledge of y (blind labeling principle)

load_fraud() - Data utility that downloads and caches the fraud detection dataset from Zenodo (no credentials required), returning features, labels, and metadata.

Quick Example

from tabullm import load_fraud, TextColumnTransformer, GMMFeatureExtractor, ClusterExplainer
from langchain_huggingface import HuggingFaceEmbeddings
from langchain_openai import ChatOpenAI
from sklearn.pipeline import Pipeline
from sklearn.ensemble import RandomForestClassifier
from sklearn.model_selection import train_test_split

# Load data
X, y, metadata = load_fraud()
text_cols = ['title', 'location', 'department', 'company_profile',
             'description', 'requirements', 'benefits']
X_train, X_test, y_train, y_test = train_test_split(
    X, y, test_size=0.3, stratify=y, random_state=42
)

# Embed text columns
embedding_model = HuggingFaceEmbeddings(
    model_name='sentence-transformers/all-MiniLM-L6-v2'
)
text_transformer = TextColumnTransformer(model=embedding_model)

# Build pipeline: Embed → Reduce → Classify
pipeline = Pipeline([
    ('embed', text_transformer),
    ('reduce', GMMFeatureExtractor(n_components=10, random_state=42)),
    ('classify', RandomForestClassifier(n_estimators=100, random_state=42))
])

# Fit and predict
pipeline.fit(X_train[text_cols], y_train)
y_pred = pipeline.predict_proba(X_test[text_cols])[:, 1]

# Interpret clusters
explainer = ClusterExplainer(
    llm=ChatOpenAI(model='gpt-4o-mini'),
    text_transformer=text_transformer,
    observations='job postings',
    text_fields='title, location, department, company profile, '
               'description, requirements, and benefits'
)

gmm = pipeline.named_steps['reduce']
cluster_labels = gmm.labels_

# Cluster descriptions only
result_df = explainer.explain(X_train[text_cols], cluster_labels)

# With outcome association + synthesis narrative
result_df, global_stats, synthesis = explainer.explain(
    X_train[text_cols], cluster_labels,
    y=y_train,
    y_label='fraudulent posting (1=fraud, 0=legitimate)',
    synthesize=True
)

# Include GMM cluster quality diagnostics in the association table
obs_stats = gmm.assignment_confidence_stats(
    pipeline.named_steps['embed'].transform(X_train[text_cols])
)
result_df, global_stats, stat_assoc_df, synthesis = explainer.explain(
    X_train[text_cols], cluster_labels,
    y=y_train,
    y_label='fraudulent posting (1=fraud, 0=legitimate)',
    observation_stats=obs_stats,
    synthesize=True
)

Examples

The examples/ folder contains Jupyter notebooks demonstrating common workflows:

  • 01_fraud_detection_walkthrough.ipynb — core TabuLLM workflow on the fraud detection dataset: TF-IDF vs. LLM embeddings, GMM-based dimensionality reduction with cluster quality diagnostics, full ClusterExplainer usage (cost preview, outcome-based testing, per-observation diagnostics, narrative synthesis), and a predictive pipeline combining text and structured features
  • 02_advanced_pipelines.ipynb — advanced pipeline patterns: forward/backward column sweep to measure marginal contribution of each text column, and stacking ensembles (single-split and multi-split) that process column groups independently and combine predictions via a meta-learner

Reproducibility assets

The paper_experiments/ folder contains the scripts, pinned environment, archived summaries, and reproduction instructions used for the SoftwareX fraud-benchmark experiments.

Key Features

  • sklearn-compatible API (Pipeline, ColumnTransformer, GridSearchCV)
  • Access to 50+ embedding models via LangChain
  • Multi-column text handling with flexible concatenation
  • Optional L2 normalization of embedding vectors
  • Token and cost estimation before embedding API calls
  • GMM-based dimensionality reduction with per-cluster log-joint features
  • Optional marginal log-density feature for explicit outlier scoring
  • Per-observation cluster quality diagnostics (max posterior, entropy, log-joint margin, log density)
  • Automatic recursive summarization for arbitrarily large datasets
  • Cost estimation for LLM explanation calls
  • Outcome-based cluster characterization (binary and continuous outcomes)
  • User-supplied per-observation covariates in the association table
  • Synthesis narrative connecting cluster descriptions to outcome patterns
  • Blind labeling: cluster descriptions generated without knowledge of outcome vector

Release Notes

See CHANGELOG.md.

Citation

If you use TabuLLM in academic work, please cite:

Sharabiani, M.T.A., Bottle, A., and Mahani, A.S. (2026). TabuLLM: Feature extraction and interpretation of text columns in tabular data using large language models. SoftwareX, 35, 102810. https://doi.org/10.1016/j.softx.2026.102810

Related work

Sharabiani, M.T.A., Mahani, A.S., Bottle, A. et al. (2025). GenAI exceeds clinical experts in predicting acute kidney injury following paediatric cardiopulmonary bypass. Scientific Reports, 15, 20847. https://doi.org/10.1038/s41598-025-04651-8

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tabullm-1.4.0.tar.gz (41.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tabullm-1.4.0-py3-none-any.whl (30.4 kB view details)

Uploaded Python 3

File details

Details for the file tabullm-1.4.0.tar.gz.

File metadata

  • Download URL: tabullm-1.4.0.tar.gz
  • Upload date:
  • Size: 41.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for tabullm-1.4.0.tar.gz
Algorithm Hash digest
SHA256 06bd8ac75a814300375acd94f799e3e65b0b6a35423d66b55f4715efd1d8c84a
MD5 1264474a0a15fe1d286bbafad0f2ae1c
BLAKE2b-256 79b339d3aa18b5f34fd059ab8030dc2f963ed8b693a3d3b20bd54f3ed9b1178b

See more details on using hashes here.

Provenance

The following attestation bundles were made for tabullm-1.4.0.tar.gz:

Publisher: release.yml on asmahani/TabuLLM

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tabullm-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: tabullm-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 30.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for tabullm-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 901e65a22c5518be90545a10612b4101c9a831c6c31fcfd291eabcdcf98c49b5
MD5 6d35faf23eea2d7f4934c4d0864f216e
BLAKE2b-256 2452a8a7da871e8cfe303aa389a85523e889dc59d76fb82362e0ffbea806b0ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for tabullm-1.4.0-py3-none-any.whl:

Publisher: release.yml on asmahani/TabuLLM

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page