Skip to main content

Seamless Feature Extraction and Interpretation of Text Columns in Tabular Data Using Large Language Models

Reason this release was yanked:

faulty build

Project description

TabuLLM

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.

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).

SphericalKMeans - K-means clustering with cosine distance for L2-normalized embeddings. For normalized embeddings, mathematically equivalent to sklearn's KMeans. Available as an alternative hard-clustering option when GMM-based features are not needed.

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 TextColumnTransformer, GMMFeatureExtractor, ClusterExplainer
from langchain_huggingface import HuggingFaceEmbeddings
from langchain_openai import ChatOpenAI
from sklearn.pipeline import Pipeline
from sklearn.ensemble import RandomForestClassifier

# Embed text columns
embedding_model = HuggingFaceEmbeddings(
    model_name='sentence-transformers/all-MiniLM-L6-v2'
)
text_transformer = TextColumnTransformer(
    model=embedding_model,
    colnames={'title': 'Title', 'description': 'Description'}
)

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

# Fit and predict
pipeline.fit(df[['title', 'description']], y)
predictions = pipeline.predict(df_new[['title', 'description']])

# Interpret clusters
explainer = ClusterExplainer(
    llm=ChatOpenAI(model='gpt-4o-mini'),
    text_transformer=text_transformer,
    observations='job postings',
    text_fields='titles and descriptions'
)

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

# Cluster descriptions only
result_df = explainer.explain(df, cluster_labels)

# With outcome association + synthesis narrative
result_df, global_stats, synthesis = explainer.explain(
    df, cluster_labels,
    y=y,
    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(df)
)
result_df, global_stats, stat_assoc_df, synthesis = explainer.explain(
    df, cluster_labels,
    y=y,
    y_label='fraudulent posting (1=fraud, 0=legitimate)',
    observation_stats=obs_stats,
    synthesize=True
)

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

Citation

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

Project details


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.0.1.tar.gz (40.6 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.0.1-py3-none-any.whl (30.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tabullm-1.0.1.tar.gz
  • Upload date:
  • Size: 40.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for tabullm-1.0.1.tar.gz
Algorithm Hash digest
SHA256 e2962d7d55ea9168bf87ee6da26ebfc0c4b2bee695d43e5c4a6d3c05e586eae5
MD5 ccad288da262ec5b8e746270ef706611
BLAKE2b-256 afe89c3099a40317aa8b10896385bb96df5d9c14cc2db6d420836182dc633326

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tabullm-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 30.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for tabullm-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 889795db1f746a9e985680850e95dc792d7c4865860a463efeb340fdfd07dd5b
MD5 81066026ad6df92f8e93679efbb24408
BLAKE2b-256 e14f5d27595b7ce1d0a945d01e66ac7d7ef229110399014fd33e9d9ce47dd85c

See more details on using hashes here.

Supported by

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