File size: 13,275 Bytes
7eba88d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 | """
Topic Modeling Engine
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
Problem: Product teams were reading thousands of reviews manually to find
recurring themes. They missed emerging issues and couldn't prioritize roadmap
decisions based on customer frequency.
Solution: Automated topic discovery using NMF (Non-negative Matrix
Factorization) β fast, interpretable, and more coherent than LDA for short
texts like reviews and tweets.
Output: Named topic clusters with example posts, keyword weights, and
sentiment distribution per cluster.
"""
from __future__ import annotations
import re
import logging
from typing import List, Dict, Tuple, Optional
from collections import Counter
import numpy as np
from sklearn.feature_extraction.text import TfidfVectorizer
from sklearn.decomposition import NMF, LatentDirichletAllocation
from sklearn.preprocessing import normalize
logger = logging.getLogger(__name__)
# βββ Stop words (reduced to keep domain-specific terms) ββββββββββββββββββββββ
CUSTOM_STOP_WORDS = [
"the", "a", "an", "and", "or", "but", "in", "on", "at", "to", "for",
"of", "with", "by", "from", "is", "was", "are", "were", "be", "been",
"have", "has", "had", "do", "does", "did", "will", "would", "could",
"should", "may", "might", "shall", "can", "this", "that",
"these", "those", "i", "we", "you", "they", "he", "she", "it",
"my", "our", "your", "their", "its", "me", "us", "them", "him", "her",
"very", "really", "just", "also", "even", "still",
"when", "where", "how", "what", "which", "who", "why",
"so", "as", "if", "up", "out", "about",
]
# βββ Human-readable topic name mapping ββββββββββββββββββββββββββββββββββββ
TOPIC_NAME_MAP = {
frozenset(["performance", "speed", "slow", "load", "latency", "fast", "crash"]): "Performance & Speed",
frozenset(["price", "billing", "cost", "expensive", "subscription", "fee", "refund"]): "Pricing & Billing",
frozenset(["support", "team", "response", "customer", "service", "help", "ticket"]): "Customer Support",
frozenset(["ui", "interface", "design", "dashboard", "navigation", "layout", "ux"]): "UI & Design",
frozenset(["feature", "api", "integration", "export", "report", "function", "capability"]): "Features & Integrations",
frozenset(["setup", "onboard", "doc", "documentation", "guide", "install", "config"]): "Onboarding & Docs",
frozenset(["data", "accuracy", "model", "analysis", "insight", "quality", "reliable"]): "Data Quality & Accuracy",
frozenset(["security", "privacy", "breach", "auth", "compliance", "sso", "gdpr"]): "Security & Compliance",
}
def _clean_text(text: str) -> str:
"""Normalize text for vectorization."""
text = text.lower()
text = re.sub(r"http\S+|www\S+|@\w+|#\w+", " ", text)
text = re.sub(r"[^a-z\s]", " ", text)
text = re.sub(r"\s+", " ", text).strip()
return text
def _infer_topic_name(keywords: List[str]) -> str:
"""Heuristically name a topic from its top keywords."""
keyword_set = set(keywords[:8])
best_match = None
best_overlap = 0
for key_words, name in TOPIC_NAME_MAP.items():
overlap = len(keyword_set & key_words)
if overlap > best_overlap:
best_overlap = overlap
best_match = name
if best_match and best_overlap >= 1:
return best_match
# Fallback: capitalize the top keyword
return keywords[0].replace("_", " ").title() + " Issues" if keywords else "General Feedback"
class TopicModeler:
"""
NMF-based topic modeling optimized for short product review texts.
Why NMF over LDA?
- LDA assumes bag-of-words with Dirichlet priors β good for long documents.
- NMF with TF-IDF produces more coherent, interpretable topics for short texts.
- Faster training, better topic separation for review-length inputs.
"""
def __init__(self, n_topics: int = 8, max_features: int = 3000):
self.n_topics = n_topics
self.max_features = max_features
self.vectorizer: Optional[TfidfVectorizer] = None
self.model: Optional[NMF] = None
self.feature_names: List[str] = []
self.topic_names: List[str] = []
self.is_fitted = False
def fit(self, texts: List[str]) -> "TopicModeler":
"""Fit the topic model on a corpus of texts."""
cleaned = [_clean_text(t) for t in texts]
# Filter out empty strings
cleaned = [t for t in cleaned if t.strip()]
if len(cleaned) < 10:
logger.warning(f"Too few valid documents ({len(cleaned)}). Using simple clustering.")
self._create_fallback_topics(texts)
return self
self.vectorizer = TfidfVectorizer(
max_features=self.max_features,
stop_words=CUSTOM_STOP_WORDS,
ngram_range=(1, 2),
min_df=1, # Lower threshold - accept terms in at least 1 doc
max_df=0.95, # Higher threshold - keep more terms
sublinear_tf=True,
)
try:
tfidf_matrix = self.vectorizer.fit_transform(cleaned)
self.feature_names = self.vectorizer.get_feature_names_out().tolist()
# Check if matrix is valid
if tfidf_matrix.nnz == 0 or len(self.feature_names) < self.n_topics:
logger.warning("TF-IDF matrix is too sparse. Using fallback topics.")
self._create_fallback_topics(texts)
return self
self.model = NMF(
n_components=self.n_topics,
init="nndsvd", # Changed from nndsvda - more robust
random_state=42,
max_iter=300,
alpha_W=0.0, # Reduced regularization
alpha_H=0.0,
l1_ratio=0.0,
)
self.model.fit(tfidf_matrix)
self.topic_names = [
_infer_topic_name(self._get_topic_keywords(i, top_n=10))
for i in range(self.n_topics)
]
self.is_fitted = True
logger.info(f"Topic model fitted. Topics: {self.topic_names}")
except Exception as e:
logger.error(f"Topic model fitting failed: {e}. Using fallback.")
self._create_fallback_topics(texts)
return self
def _create_fallback_topics(self, texts: List[str]) -> None:
"""Create a simple fallback topic model when NMF fails."""
logger.warning("Creating fallback topic model with keyword-based clustering")
self.n_topics = 5 # Reduced number of topics for fallback
self.topic_names = [
"Performance & Speed",
"Customer Support",
"Pricing & Billing",
"Features & UI",
"General Feedback"
]
self.is_fitted = True
self._fallback_mode = True
# Store texts for fallback classification
self._fallback_texts = texts[:100] # Keep sample for reference
def _get_topic_keywords(self, topic_idx: int, top_n: int = 12) -> List[str]:
"""Return top keywords for a topic."""
if not hasattr(self, 'model') or self.model is None:
# Fallback keywords
fallback_keywords = {
0: ['slow', 'fast', 'speed', 'performance', 'loading', 'lag', 'crash'],
1: ['support', 'help', 'response', 'team', 'customer', 'service'],
2: ['price', 'pricing', 'cost', 'expensive', 'billing', 'subscription'],
3: ['feature', 'ui', 'interface', 'design', 'dashboard', 'ux'],
4: ['good', 'better', 'platform', 'recommend', 'experience', 'overall']
}
return fallback_keywords.get(topic_idx, ['general', 'feedback'])[:top_n]
topic_vector = self.model.components_[topic_idx]
top_indices = topic_vector.argsort()[::-1][:top_n]
return [self.feature_names[i] for i in top_indices]
def transform(self, texts: List[str]) -> np.ndarray:
"""Assign topic distributions to texts."""
if hasattr(self, '_fallback_mode') and self._fallback_mode:
# Simple keyword-based assignment for fallback
n = len(texts)
distributions = np.zeros((n, self.n_topics))
keywords = {
0: ['slow', 'speed', 'performance', 'loading', 'fast', 'lag'],
1: ['support', 'help', 'response', 'team', 'customer'],
2: ['price', 'pricing', 'cost', 'expensive', 'billing'],
3: ['feature', 'ui', 'interface', 'design', 'dashboard'],
4: [] # default
}
for i, text in enumerate(texts):
text_lower = text.lower()
scores = np.zeros(self.n_topics)
for topic_id, words in keywords.items():
scores[topic_id] = sum(1 for w in words if w in text_lower)
# Assign to topic with most keyword matches, or default to last topic
if scores.sum() > 0:
scores = scores / scores.sum()
else:
scores[-1] = 1.0
distributions[i] = scores
return distributions
# Normal NMF transform
cleaned = [_clean_text(t) for t in texts]
tfidf = self.vectorizer.transform(cleaned)
return self.model.transform(tfidf)
def get_document_topics(self, texts: List[str]) -> List[int]:
"""Return the dominant topic index for each text."""
distributions = self.transform(texts)
return distributions.argmax(axis=1).tolist()
def get_topics_summary(
self,
texts: List[str],
sentiments: Optional[List[str]] = None,
top_n_keywords: int = 10,
) -> List[Dict]:
"""
Full topic summary with keywords, example posts, sentiment breakdown,
and cluster size β ready for frontend visualization.
"""
if not self.is_fitted:
raise RuntimeError("Model must be fitted before calling get_topics_summary.")
topic_assignments = self.get_document_topics(texts)
# Group texts by topic
topic_buckets: Dict[int, List[int]] = {i: [] for i in range(self.n_topics)}
for idx, topic in enumerate(topic_assignments):
topic_buckets[topic].append(idx)
summary = []
for topic_idx in range(self.n_topics):
indices = topic_buckets[topic_idx]
if not indices:
continue
keywords = self._get_topic_keywords(topic_idx, top_n=top_n_keywords)
examples = [texts[i] for i in indices[:3]] # Top 3 representative posts
# Sentiment breakdown if available
sentiment_dist = {"positive": 0, "negative": 0, "neutral": 0, "crisis": 0}
if sentiments:
for i in indices:
lbl = sentiments[i] if i < len(sentiments) else "neutral"
sentiment_dist[lbl] = sentiment_dist.get(lbl, 0) + 1
total = len(indices)
dominant_sentiment = max(sentiment_dist, key=sentiment_dist.get) if sentiments else "neutral"
# Keyword weights for visualization (bubble size / word cloud)
kw_weights = {}
if hasattr(self, 'model') and self.model is not None:
topic_vector = self.model.components_[topic_idx]
for kw in keywords:
if kw in self.feature_names:
feat_idx = self.feature_names.index(kw)
kw_weights[kw] = float(round(topic_vector[feat_idx], 4))
else:
# Fallback: assign uniform weights
for i, kw in enumerate(keywords):
kw_weights[kw] = float(round(1.0 - (i * 0.1), 2))
summary.append({
"id": topic_idx,
"name": self.topic_names[topic_idx],
"keywords": keywords,
"keyword_weights": kw_weights,
"post_count": total,
"percentage": round(100 * total / max(len(texts), 1), 1),
"dominant_sentiment": dominant_sentiment,
"sentiment_distribution": sentiment_dist,
"examples": examples,
})
return sorted(summary, key=lambda x: x["post_count"], reverse=True)
# βββ Singleton ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
_modeler: Optional[TopicModeler] = None
def get_modeler(n_topics: int = 8) -> TopicModeler:
global _modeler
if _modeler is None:
_modeler = TopicModeler(n_topics=n_topics)
return _modeler
|