File size: 11,289 Bytes
219ee1a | 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 | """
LLM-based explanation generator β calls the Hugging Face Inference API
instead of running Qwen locally.
Why
---
The deployment server (Render / Railway / VPS) doesn't run any LLM weights;
all generation happens on Hugging Face's infrastructure. The server just
needs an HF user-access token in the HF_TOKEN env var.
Behaviour
---------
* Sends the same chat-style prompt the original notebook used.
* Falls back to the deterministic rule-based explanation if:
- DISABLE_LLM_EXPLAINER=1, OR
- HF_TOKEN is missing, OR
- the API call errors / times out.
* Caches the failure flag so we don't hammer the API on every request when
it's clearly down.
"""
import logging
import os
import re
import threading
logger = logging.getLogger("explainer")
# ββ Config βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
LLM_MODEL_NAME = os.getenv("LLM_MODEL_NAME", "Qwen/Qwen2.5-1.5B-Instruct")
DISABLE_LLM = os.getenv("DISABLE_LLM_EXPLAINER", "0") == "1"
LLM_MAX_NEW_TOKENS = int(os.getenv("LLM_MAX_NEW_TOKENS", "120"))
LLM_TEMPERATURE = float(os.getenv("LLM_TEMPERATURE", "0.3"))
LLM_TIMEOUT = float(os.getenv("LLM_TIMEOUT", "60"))
HF_TOKEN = os.getenv("HF_TOKEN")
# Optional: pin a specific HF Inference Provider (e.g. "together", "fireworks-ai",
# "hf-inference"). Leave unset to let HF auto-route.
HF_PROVIDER = os.getenv("HF_PROVIDER")
_failed_lock = threading.Lock()
_llm_failed = False # latched on first hard failure to avoid retry storms
_inference_client = None
_client_lock = threading.Lock()
def _get_client():
"""Lazy-init the huggingface_hub InferenceClient."""
global _inference_client
if _inference_client is not None:
return _inference_client
with _client_lock:
if _inference_client is not None:
return _inference_client
from huggingface_hub import InferenceClient
kwargs = {"token": HF_TOKEN, "timeout": LLM_TIMEOUT}
if HF_PROVIDER:
kwargs["provider"] = HF_PROVIDER
_inference_client = InferenceClient(**kwargs)
logger.info(
"InferenceClient ready (model=%s, provider=%s)",
LLM_MODEL_NAME, HF_PROVIDER or "auto",
)
return _inference_client
# ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# 1. Post-processing β same rules as the notebook
# ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def _clean_explanation(text: str) -> str:
text = re.sub(r"<think>.*?</think>", "", text, flags=re.DOTALL)
for pat in (
r"^No other text[.\s]*",
r"^Explanation:\s*",
r"^Output:\s*",
r"^Feedback:\s*",
r"^Answer:\s*",
):
text = re.sub(pat, "", text, flags=re.IGNORECASE)
text = re.sub(r"\s+", " ", text).strip()
# Cap at 2 sentences.
parts = re.split(r"(?<=[.!?])\s+(?=[A-Z])", text)
if len(parts) > 2:
text = " ".join(parts[:2])
if text and text[-1] not in ".!?":
text += "."
return text.strip()
# ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# 2. Prompt construction β identical to the original
# ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def _build_messages(criterion_name, score, max_score,
question, answer, signals, criterion_desc=None):
top_tokens = signals.get("top_answer_tokens", [])
unattended = signals.get("unattended_concepts", [])
confidence = signals.get("confidence", 0.0)
source = signals.get("source", "cross_attention")
tok_lines = [
f'"{t.get("token", "")}" (importance: {float(t.get("importance", 0)):.4f})'
for t in top_tokens
]
tok_str = "; ".join(tok_lines) if tok_lines else "(none)"
miss_str = ", ".join([f'"{x}"' for x in unattended]) if unattended else "(none)"
rubric_str = ""
if criterion_desc and criterion_desc != criterion_name:
rubric_str = f"Rubric: {criterion_desc}\n"
percent = (score / max_score * 100) if max_score else 0
evidence_label = (
"Tokens the grading model attended to most:"
if source == "cross_attention"
else "Tokens that most influenced this score:"
)
system_msg = (
"You are a concise grading assistant. "
"You write EXACTLY 2 sentences of feedback for a student. "
"Sentence 1: why this score was given. "
"Sentence 2: what is missing or how to improve. "
"Rules: no bullet points, no paragraphs, no lists, no extra sentences. "
"Output only those 2 sentences and nothing else."
)
user_msg = (
f"CRITERION: {criterion_name}\n"
f"SCORE: {score:.2f} / {max_score} ({percent:.0f}%)\n"
f"CONFIDENCE: {confidence * 100:.0f}%\n"
f"{rubric_str}"
f"\nQUESTION:\n{question}\n"
f"\nSTUDENT ANSWER:\n{answer}\n"
f"\n{evidence_label}\n{tok_str}\n"
f"\nConcepts with low coverage: {miss_str}\n"
f"\nWrite exactly 2 sentences of feedback."
)
return [
{"role": "system", "content": system_msg},
{"role": "user", "content": user_msg},
]
# ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# 3. HF Inference API caller (OpenAI-compatible chat-completions endpoint)
# ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def _call_hf_chat(messages):
"""Returns the raw assistant text, or raises on failure."""
if not HF_TOKEN:
raise RuntimeError("HF_TOKEN env var is not set")
client = _get_client()
resp = client.chat_completion(
model=LLM_MODEL_NAME,
messages=messages,
max_tokens=LLM_MAX_NEW_TOKENS,
temperature=LLM_TEMPERATURE,
)
try:
return resp.choices[0].message.content
except (AttributeError, IndexError, TypeError):
raise RuntimeError(f"Unexpected HF chat response shape: {resp!r}")
# ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# 4. Rule-based fallback (no LLM needed)
# ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def _band(pred_norm):
if pred_norm >= 0.85: return "excellent"
if pred_norm >= 0.65: return "good"
if pred_norm >= 0.40: return "partial"
if pred_norm >= 0.15: return "weak"
return "very poor"
def _rule_based_explanation(criterion_name, pred_norm, score, max_score, signals):
band = _band(pred_norm)
top_tokens = [t["token"] for t in signals.get("top_answer_tokens", [])[:3]]
unattended = signals.get("unattended_concepts", [])[:3]
s1 = (
f"The answer earned {score:.2f} / {max_score:.0f} on '{criterion_name}' "
f"({band}, {pred_norm*100:.0f}%)"
)
if top_tokens:
s1 += f"; the model focused on: {', '.join(top_tokens)}."
else:
s1 += "."
if unattended and pred_norm < 0.85:
s2 = f"To improve, address the under-covered concepts: {', '.join(unattended)}."
else:
s2 = "The response covers the main rubric points."
return f"{s1} {s2}"
# ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# 5. Public API β same signature as before
# ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def build_explanation(criterion_name, pred_norm, score, max_score, signals,
question=None, answer=None, criterion_desc=None):
global _llm_failed
if DISABLE_LLM or _llm_failed or not HF_TOKEN:
return _rule_based_explanation(criterion_name, pred_norm, score, max_score, signals)
if question is None or answer is None:
return _rule_based_explanation(criterion_name, pred_norm, score, max_score, signals)
messages = _build_messages(
criterion_name=criterion_name,
score=score,
max_score=max_score,
question=question,
answer=answer,
signals=signals,
criterion_desc=criterion_desc,
)
try:
raw = _call_hf_chat(messages)
return _clean_explanation(raw)
except Exception as e:
# Latch the failure flag on auth-style errors so we stop retrying.
msg = str(e)
if "401" in msg or "403" in msg or "HF_TOKEN" in msg:
with _failed_lock:
_llm_failed = True
logger.warning(
"Disabling LLM explainer for the rest of this process: %s", e
)
else:
logger.warning("LLM call failed (%s) β using rule-based fallback this request.", e)
return _rule_based_explanation(criterion_name, pred_norm, score, max_score, signals)
# ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# 6. Signal normalisation helper (unchanged)
# ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def normalize_signals(signals):
if signals is None:
signals = {}
missed = signals.get("missed_answer_tokens", [])
active = signals.get("active_rubric_concepts", [])
if "unattended_concepts" not in signals:
signals["unattended_concepts"] = missed or active or []
signals.setdefault("top_answer_tokens", [])
signals.setdefault("confidence", 0.0)
signals.setdefault("source", "cross_attention")
return signals
|