File size: 47,161 Bytes
d3a0265 | 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 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 | <!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<title>MindScan β How It Works (Team Reference)</title>
<link href="https://fonts.googleapis.com/css2?family=Instrument+Serif:ital@0;1&family=Geist:wght@300;400;500&family=DM+Mono:wght@400;500&display=swap" rel="stylesheet">
<style>
:root{
--bg:#f7f5f0;--bg2:#efece8;--bg3:#e6e2da;
--ink:#1a1816;--ink2:#5c5750;--ink3:#9c9790;
--border:rgba(26,24,22,0.09);--border2:rgba(26,24,22,0.16);
--blue:#1d4ed8;--blue-bg:#eff6ff;
--amber:#b45309;--amber-bg:#fffbeb;
--red:#b91c1c;--red-bg:#fef2f2;
--green:#15803d;--green-bg:#f0fdf4;
--purple:#6d28d9;--purple-bg:#f5f3ff;
--teal:#0f766e;--teal-bg:#f0fdfa;
}
*{box-sizing:border-box;margin:0;padding:0}
body{background:var(--bg);color:var(--ink);font-family:'Geist',sans-serif;font-size:14px;line-height:1.6;min-height:100vh}
header{padding:16px 40px;display:flex;align-items:center;justify-content:space-between;border-bottom:1px solid var(--border);background:rgba(247,245,240,.95);position:sticky;top:0;z-index:20;backdrop-filter:blur(8px)}
.logo{font-family:'Instrument Serif',serif;font-size:17px;letter-spacing:-.02em}.logo em{font-style:italic;color:var(--ink2)}
.hbadge{font-size:10px;font-family:'DM Mono',monospace;background:var(--blue-bg);color:var(--blue);border:1px solid rgba(29,78,216,.2);padding:3px 9px;border-radius:20px}
/* LAYOUT */
.layout{display:grid;grid-template-columns:320px 1fr;min-height:calc(100vh - 53px)}
.sidebar{background:#fff;border-right:1px solid var(--border);padding:24px 20px;overflow-y:auto;position:sticky;top:53px;height:calc(100vh - 53px)}
.main{padding:32px 36px}
/* SIDEBAR */
.sb-title{font-size:11px;font-family:'DM Mono',monospace;letter-spacing:.1em;text-transform:uppercase;color:var(--ink3);margin-bottom:14px}
.step-list{display:flex;flex-direction:column;gap:4px;margin-bottom:24px}
.step-btn{display:flex;align-items:center;gap:10px;padding:10px 12px;border-radius:8px;cursor:pointer;border:1px solid transparent;transition:all .15s;text-align:left;background:none;width:100%}
.step-btn:hover{background:var(--bg2);border-color:var(--border)}
.step-btn.active{background:var(--ink);border-color:var(--ink)}
.step-btn.active .sb-num{background:rgba(255,255,255,.15);color:#fff}
.step-btn.active .sb-name{color:#fff}
.step-btn.active .sb-loc{color:rgba(255,255,255,.55)}
.sb-num{width:26px;height:26px;border-radius:6px;background:var(--bg2);display:flex;align-items:center;justify-content:center;font-size:11px;font-family:'DM Mono',monospace;font-weight:500;color:var(--ink2);flex-shrink:0}
.sb-info{min-width:0}
.sb-name{font-size:13px;font-weight:500;color:var(--ink);white-space:nowrap;overflow:hidden;text-overflow:ellipsis}
.sb-loc{font-size:10px;font-family:'DM Mono',monospace;color:var(--ink3);margin-top:1px}
.sb-divider{height:1px;background:var(--border);margin:12px 0}
.sb-section{font-size:10px;font-family:'DM Mono',monospace;letter-spacing:.1em;text-transform:uppercase;color:var(--ink3);margin-bottom:8px;margin-top:4px}
/* KEY LEGEND */
.legend{background:var(--bg2);border-radius:8px;padding:12px 14px}
.legend-title{font-size:10px;font-family:'DM Mono',monospace;letter-spacing:.08em;text-transform:uppercase;color:var(--ink3);margin-bottom:8px}
.leg-row{display:flex;align-items:center;gap:8px;margin-bottom:5px;font-size:11px;color:var(--ink2)}
.leg-dot{width:10px;height:10px;border-radius:50%;flex-shrink:0}
/* MAIN CONTENT */
.step-content{display:none;animation:fadeIn .2s ease}
.step-content.active{display:block}
@keyframes fadeIn{from{opacity:0;transform:translateY(4px)}to{opacity:1;transform:translateY(0)}}
.step-header{display:flex;align-items:flex-start;gap:16px;margin-bottom:24px}
.step-icon{width:44px;height:44px;border-radius:10px;display:flex;align-items:center;justify-content:center;font-size:20px;flex-shrink:0}
.step-num-big{font-family:'DM Mono',monospace;font-size:11px;font-weight:500;margin-bottom:4px}
.step-title{font-family:'Instrument Serif',serif;font-size:26px;letter-spacing:-.02em;color:var(--ink);margin-bottom:4px}
.step-file{font-size:11px;font-family:'DM Mono',monospace;color:var(--ink3)}
.code-block{background:var(--ink);border-radius:10px;padding:18px 20px;font-family:'DM Mono',monospace;font-size:12px;line-height:1.9;color:#e2dfd8;margin-bottom:16px;overflow-x:auto}
.code-block .kw{color:#79b8ff}
.code-block .fn{color:#b3d9ff}
.code-block .str{color:#9ecf72}
.code-block .cm{color:#6b7d8a}
.code-block .num{color:#f0c479}
.code-block .cls{color:#e2b36a}
.what-box{background:var(--bg2);border:1px solid var(--border);border-radius:10px;padding:16px 18px;margin-bottom:16px}
.what-title{font-size:11px;font-family:'DM Mono',monospace;letter-spacing:.08em;text-transform:uppercase;color:var(--ink3);margin-bottom:8px}
.what-body{font-size:13px;color:var(--ink2);line-height:1.65}
.what-body strong{color:var(--ink)}
.important-box{border-radius:10px;padding:14px 16px;margin-bottom:16px;border:1px solid;font-size:12px;line-height:1.6}
.imp-blue{background:var(--blue-bg);border-color:rgba(29,78,216,.2);color:#1e3a8a}
.imp-amber{background:var(--amber-bg);border-color:rgba(180,83,9,.2);color:#78350f}
.imp-green{background:var(--green-bg);border-color:rgba(21,128,61,.2);color:#14532d}
.imp-red{background:var(--red-bg);border-color:rgba(185,28,28,.2);color:#7f1d1d}
.imp-purple{background:var(--purple-bg);border-color:rgba(109,40,217,.2);color:#3b0764}
.imp-title{font-weight:500;margin-bottom:3px}
.returns-box{background:#fff;border:1px solid var(--border);border-radius:10px;padding:16px 18px;margin-bottom:16px}
.ret-title{font-size:11px;font-family:'DM Mono',monospace;letter-spacing:.08em;text-transform:uppercase;color:var(--ink3);margin-bottom:10px}
.ret-row{display:flex;align-items:flex-start;gap:10px;padding:7px 0;border-bottom:1px solid var(--border);font-size:12px}
.ret-row:last-child{border-bottom:none}
.ret-key{font-family:'DM Mono',monospace;font-weight:500;min-width:180px;color:var(--ink)}
.ret-val{color:var(--ink2)}
/* FLOW MAP */
.flow-mini{display:flex;align-items:center;gap:8px;flex-wrap:wrap;margin-bottom:20px;background:var(--bg2);border-radius:10px;padding:12px 16px}
.flow-node{font-size:10px;font-family:'DM Mono',monospace;padding:4px 9px;border-radius:5px;border:1px solid var(--border);background:#fff;white-space:nowrap}
.flow-node.active-node{background:var(--ink);color:#fff;border-color:var(--ink)}
.flow-arrow{color:var(--ink3);font-size:12px}
/* NAV BUTTONS */
.nav-btns{display:flex;justify-content:space-between;margin-top:24px;padding-top:16px;border-top:1px solid var(--border)}
.nav-btn{font-size:12px;font-family:'DM Mono',monospace;padding:7px 16px;border-radius:7px;border:1px solid var(--border2);background:var(--bg2);color:var(--ink2);cursor:pointer;transition:all .15s}
.nav-btn:hover{background:var(--ink);color:#fff;border-color:var(--ink)}
.nav-btn:disabled{opacity:.35;cursor:not-allowed}
@media(max-width:768px){.layout{grid-template-columns:1fr}.sidebar{position:static;height:auto;border-right:none;border-bottom:1px solid var(--border)}}
</style>
</head>
<body>
<header>
<div class="logo">Mind<em>Scan</em> β <em>System Flow</em></div>
<div class="hbadge">Team Reference Β· GitHub</div>
</header>
<div class="layout">
<!-- SIDEBAR -->
<div class="sidebar">
<div class="sb-title">What happens when you click Run?</div>
<div class="sb-section">Frontend β index.html</div>
<div class="step-list">
<button class="step-btn active" onclick="goTo(0)">
<div class="sb-num" style="background:var(--blue-bg);color:var(--blue)">1</div>
<div class="sb-info"><div class="sb-name">Button click</div><div class="sb-loc">index.html β runAnalysis()</div></div>
</button>
<button class="step-btn" onclick="goTo(1)">
<div class="sb-num" style="background:var(--blue-bg);color:var(--blue)">2</div>
<div class="sb-info"><div class="sb-name">fetch('/predict')</div><div class="sb-loc">index.html β POST request</div></div>
</button>
</div>
<div class="sb-section">Backend β app.py</div>
<div class="step-list">
<button class="step-btn" onclick="goTo(2)">
<div class="sb-num" style="background:var(--amber-bg);color:var(--amber)">3</div>
<div class="sb-info"><div class="sb-name">Flask receives it</div><div class="sb-loc">app.py β predict()</div></div>
</button>
</div>
<div class="sb-section">Prediction logic β predict.py</div>
<div class="step-list">
<button class="step-btn" onclick="goTo(3)">
<div class="sb-num" style="background:var(--green-bg);color:var(--green)">4</div>
<div class="sb-info"><div class="sb-name">clean_text()</div><div class="sb-loc">predict.py β text cleaning</div></div>
</button>
<button class="step-btn" onclick="goTo(4)">
<div class="sb-num" style="background:var(--green-bg);color:var(--green)">5</div>
<div class="sb-info"><div class="sb-name">predict_classical()</div><div class="sb-loc">predict.py β LR Β· SVM Β· XGBoost</div></div>
</button>
<button class="step-btn" onclick="goTo(5)">
<div class="sb-num" style="background:var(--purple-bg);color:var(--purple)">6</div>
<div class="sb-info"><div class="sb-name">predict_xlmr()</div><div class="sb-loc">predict.py β transformer</div></div>
</button>
<button class="step-btn" onclick="goTo(6)">
<div class="sb-num" style="background:var(--green-bg);color:var(--green)">7</div>
<div class="sb-info"><div class="sb-name">predict_all()</div><div class="sb-loc">predict.py β assembles all 12</div></div>
</button>
</div>
<div class="sb-section">Response β back to browser</div>
<div class="step-list">
<button class="step-btn" onclick="goTo(7)">
<div class="sb-num" style="background:var(--amber-bg);color:var(--amber)">8</div>
<div class="sb-info"><div class="sb-name">JSON response</div><div class="sb-loc">app.py β jsonify() β browser</div></div>
</button>
<button class="step-btn" onclick="goTo(8)">
<div class="sb-num" style="background:var(--blue-bg);color:var(--blue)">9</div>
<div class="sb-info"><div class="sb-name">render() + buildPanel()</div><div class="sb-loc">index.html β shows results</div></div>
</button>
<button class="step-btn" onclick="goTo(9)">
<div class="sb-num" style="background:var(--blue-bg);color:var(--blue)">10</div>
<div class="sb-info"><div class="sb-name">CSS bar animation</div><div class="sb-loc">index.html β confidence bars</div></div>
</button>
</div>
<div class="sb-divider"></div>
<div class="legend">
<div class="legend-title">File colours</div>
<div class="leg-row"><div class="leg-dot" style="background:var(--blue)"></div>index.html β frontend JS</div>
<div class="leg-row"><div class="leg-dot" style="background:var(--amber)"></div>app.py β Flask server</div>
<div class="leg-row"><div class="leg-dot" style="background:var(--green)"></div>predict.py β model logic</div>
<div class="leg-row"><div class="leg-dot" style="background:var(--purple)"></div>XLM-RoBERTa specific</div>
</div>
</div>
<!-- MAIN CONTENT -->
<div class="main">
<!-- STEP 0 β Button click -->
<div class="step-content active" id="step0">
<div class="flow-mini">
<div class="flow-node active-node">1 Β· Button click</div><div class="flow-arrow">β</div>
<div class="flow-node">2 Β· fetch()</div><div class="flow-arrow">β</div>
<div class="flow-node">3 Β· Flask</div><div class="flow-arrow">β</div>
<div class="flow-node">4β7 Β· predict.py</div><div class="flow-arrow">β</div>
<div class="flow-node">8 Β· JSON</div><div class="flow-arrow">β</div>
<div class="flow-node">9β10 Β· UI</div>
</div>
<div class="step-header">
<div class="step-icon" style="background:var(--blue-bg)">π±</div>
<div>
<div class="step-num-big" style="color:var(--blue)">Step 01 Β· index.html</div>
<div class="step-title">User clicks "Run all 12 models"</div>
<div class="step-file">onclick="runAnalysis()" β defined in index.html <script></div>
</div>
</div>
<div class="what-box">
<div class="what-title">What happens</div>
<div class="what-body">The button has an <strong>onclick</strong> attribute pointing to <strong>runAnalysis()</strong>. This function grabs whatever text is in the textarea, disables the button, shows a spinning animation, and starts the process. Nothing touches any model yet β this is purely UI setup.</div>
</div>
<div class="code-block"><span class="cm">// Button in HTML</span>
<button <span class="kw">onclick</span>=<span class="str">"runAnalysis()"</span>>
Run all <span class="num">12</span> models
</button>
<span class="cm">// Function in <script> at bottom of index.html</span>
<span class="kw">async function</span> <span class="fn">runAnalysis</span>() {
<span class="kw">const</span> text = document.<span class="fn">getElementById</span>(<span class="str">'textInput'</span>).value.<span class="fn">trim</span>();
<span class="kw">if</span> (!text) <span class="kw">return</span>; <span class="cm">// do nothing if textarea is empty</span>
btn.disabled = <span class="kw">true</span>; <span class="cm">// disable button while running</span>
spinner.style.display = <span class="str">'block'</span>; <span class="cm">// show spinning circle</span>
btnTxt.textContent = <span class="str">'Running 12 models...'</span>;
<span class="cm">// next: send to backend β</span>
}</div>
<div class="important-box imp-blue">
<div class="imp-title">Important for teammates</div>
The function is async (uses await). This means the browser does NOT freeze while waiting for the server β the user can still scroll the page. async/await is just a cleaner way of writing a Promise.
</div>
<div class="nav-btns">
<button class="nav-btn" disabled>β Previous</button>
<button class="nav-btn" onclick="goTo(1)">Next: fetch('/predict') β</button>
</div>
</div>
<!-- STEP 1 β fetch -->
<div class="step-content" id="step1">
<div class="flow-mini">
<div class="flow-node">1 Β· Button click</div><div class="flow-arrow">β</div>
<div class="flow-node active-node">2 Β· fetch()</div><div class="flow-arrow">β</div>
<div class="flow-node">3 Β· Flask</div><div class="flow-arrow">β</div>
<div class="flow-node">4β7 Β· predict.py</div><div class="flow-arrow">β</div>
<div class="flow-node">8 Β· JSON</div><div class="flow-arrow">β</div>
<div class="flow-node">9β10 Β· UI</div>
</div>
<div class="step-header">
<div class="step-icon" style="background:var(--blue-bg)">π‘</div>
<div>
<div class="step-num-big" style="color:var(--blue)">Step 02 Β· index.html</div>
<div class="step-title">HTTP request sent to Flask</div>
<div class="step-file">fetch('/predict') β browser's built-in HTTP function</div>
</div>
</div>
<div class="what-box">
<div class="what-title">What happens</div>
<div class="what-body">The browser sends an <strong>HTTP POST request</strong> to the Flask server at <strong>/predict</strong>. The text is sent as JSON in the request body. The browser then waits for a response β this is when the ~2 second loading spinner appears.</div>
</div>
<div class="code-block"><span class="cm">// Still inside runAnalysis() in index.html</span>
<span class="kw">const</span> r = <span class="kw">await</span> <span class="fn">fetch</span>(<span class="str">'/predict'</span>, {
method: <span class="str">'POST'</span>,
headers: { <span class="str">'Content-Type'</span>: <span class="str">'application/json'</span> },
body: <span class="cls">JSON</span>.<span class="fn">stringify</span>({ text })
<span class="cm">// sends: { "text": "I feel hopeless..." }</span>
});
<span class="kw">const</span> d = <span class="kw">await</span> r.<span class="fn">json</span>(); <span class="cm">// parse the JSON response</span>
<span class="fn">render</span>(d, text); <span class="cm">// draw results on screen</span></div>
<div class="important-box imp-amber">
<div class="imp-title">Why /predict and not a full URL?</div>
Because the frontend and backend run on the same server (localhost:5000). Flask serves both the HTML page and the API endpoint. A relative URL like /predict automatically goes to the same host.
</div>
<div class="nav-btns">
<button class="nav-btn" onclick="goTo(0)">β Button click</button>
<button class="nav-btn" onclick="goTo(2)">Next: Flask receives it β</button>
</div>
</div>
<!-- STEP 2 β Flask -->
<div class="step-content" id="step2">
<div class="flow-mini">
<div class="flow-node">1 Β· Button click</div><div class="flow-arrow">β</div>
<div class="flow-node">2 Β· fetch()</div><div class="flow-arrow">β</div>
<div class="flow-node active-node">3 Β· Flask</div><div class="flow-arrow">β</div>
<div class="flow-node">4β7 Β· predict.py</div><div class="flow-arrow">β</div>
<div class="flow-node">8 Β· JSON</div><div class="flow-arrow">β</div>
<div class="flow-node">9β10 Β· UI</div>
</div>
<div class="step-header">
<div class="step-icon" style="background:var(--amber-bg)">π</div>
<div>
<div class="step-num-big" style="color:var(--amber)">Step 03 Β· app.py</div>
<div class="step-title">Flask receives the POST request</div>
<div class="step-file">app.py β @app.route('/predict') β predict()</div>
</div>
</div>
<div class="what-box">
<div class="what-title">What happens</div>
<div class="what-body">Flask matches the incoming request to the <strong>@app.route('/predict')</strong> decorator. The predict() function extracts the text from the request body, validates it (not empty, not too long), then calls predict_all() from predict.py. It wraps the result with processing time and sends it back as JSON.</div>
</div>
<div class="code-block"><span class="cm"># app.py</span>
<span class="kw">from</span> predict <span class="kw">import</span> predict_all
<span class="kw">@app.route</span>(<span class="str">'/predict'</span>, methods=[<span class="str">'POST'</span>])
<span class="kw">def</span> <span class="fn">predict</span>():
data = request.<span class="fn">get_json</span>()
text = data[<span class="str">'text'</span>].<span class="fn">strip</span>()
<span class="cm"># validation</span>
<span class="kw">if not</span> text:
<span class="kw">return</span> <span class="fn">jsonify</span>({<span class="str">'error'</span>: <span class="str">'Text cannot be empty'</span>}), <span class="num">400</span>
<span class="kw">if</span> <span class="fn">len</span>(text) > <span class="num">5000</span>:
<span class="kw">return</span> <span class="fn">jsonify</span>({<span class="str">'error'</span>: <span class="str">'Too long'</span>}), <span class="num">400</span>
t0 = time.<span class="fn">time</span>()
result = <span class="fn">predict_all</span>(text) <span class="cm"># β the big function (next steps)</span>
result[<span class="str">'processing_time_ms'</span>] = <span class="fn">round</span>((time.<span class="fn">time</span>() - t0) * <span class="num">1000</span>)
<span class="kw">return</span> <span class="fn">jsonify</span>(result) <span class="cm"># sends JSON back to browser</span></div>
<div class="important-box imp-amber">
<div class="imp-title">Models load at STARTUP not per request</div>
The 12 models are loaded once when you run python app.py (takes ~30s). Every subsequent request reuses them from RAM. If models loaded per request it would take 30s per click.
</div>
<div class="nav-btns">
<button class="nav-btn" onclick="goTo(1)">β fetch()</button>
<button class="nav-btn" onclick="goTo(3)">Next: clean_text() β</button>
</div>
</div>
<!-- STEP 3 β clean_text -->
<div class="step-content" id="step3">
<div class="flow-mini">
<div class="flow-node">1β3 Β· Browser β Flask</div><div class="flow-arrow">β</div>
<div class="flow-node active-node">4 Β· clean_text()</div><div class="flow-arrow">β</div>
<div class="flow-node">5 Β· classical</div><div class="flow-arrow">β</div>
<div class="flow-node">6 Β· XLM-R</div><div class="flow-arrow">β</div>
<div class="flow-node">7 Β· assemble</div>
</div>
<div class="step-header">
<div class="step-icon" style="background:var(--green-bg)">π§Ή</div>
<div>
<div class="step-num-big" style="color:var(--green)">Step 04 Β· predict.py</div>
<div class="step-title">Text cleaning</div>
<div class="step-file">predict.py β clean_text(raw_text)</div>
</div>
</div>
<div class="what-box">
<div class="what-title">What happens</div>
<div class="what-body">The raw text is cleaned with the <strong>same pipeline used in training</strong>. This is critical β if you trained on cleaned text, you must clean the same way at prediction time. The classical models (LR, SVM, XGBoost) use the cleaned version. XLM-RoBERTa uses the original raw text because its tokeniser handles formatting itself.</div>
</div>
<div class="code-block"><span class="cm"># predict.py</span>
<span class="kw">def</span> <span class="fn">clean_text</span>(text):
text = <span class="fn">str</span>(text).<span class="fn">lower</span>() <span class="cm"># UPPERCASE β lowercase</span>
text = re.<span class="fn">sub</span>(<span class="str">r'http\S+|www\S+'</span>, <span class="str">''</span>, text) <span class="cm"># remove URLs</span>
text = re.<span class="fn">sub</span>(<span class="str">r'@\w+'</span>, <span class="str">''</span>, text) <span class="cm"># remove @mentions</span>
text = re.<span class="fn">sub</span>(<span class="str">r'#'</span>, <span class="str">''</span>, text) <span class="cm"># remove # (keep word)</span>
text = text.<span class="fn">translate</span>(str.<span class="fn">maketrans</span>(<span class="str">''</span>,<span class="str">''</span>,punctuation)) <span class="cm"># remove !.,?etc</span>
text = re.<span class="fn">sub</span>(<span class="str">r'\s+'</span>, <span class="str">' '</span>, text).<span class="fn">strip</span>() <span class="cm"># collapse spaces</span>
<span class="kw">return</span> text
<span class="cm"># Example:</span>
<span class="cm"># IN: "@user I've been SO depressed https://t.co #mentalhealth π’"</span>
<span class="cm"># OUT: "ive been so depressed mentalhealth"</span></div>
<div class="returns-box">
<div class="ret-title">Used by</div>
<div class="ret-row"><div class="ret-key">Classical models (LR/SVM/XGB)</div><div class="ret-val">Use the cleaned version β TF-IDF cannot handle URLs, emojis, punctuation</div></div>
<div class="ret-row"><div class="ret-key">XLM-RoBERTa</div><div class="ret-val">Uses the ORIGINAL raw_text β the transformer's tokeniser handles it better</div></div>
</div>
<div class="nav-btns">
<button class="nav-btn" onclick="goTo(2)">β Flask</button>
<button class="nav-btn" onclick="goTo(4)">Next: Classical models β</button>
</div>
</div>
<!-- STEP 4 β classical -->
<div class="step-content" id="step4">
<div class="flow-mini">
<div class="flow-node">1β4 Β· Browser β clean</div><div class="flow-arrow">β</div>
<div class="flow-node active-node">5 Β· predict_classical()</div><div class="flow-arrow">β</div>
<div class="flow-node">6 Β· XLM-R</div><div class="flow-arrow">β</div>
<div class="flow-node">7 Β· assemble</div>
</div>
<div class="step-header">
<div class="step-icon" style="background:var(--green-bg)">βοΈ</div>
<div>
<div class="step-num-big" style="color:var(--green)">Step 05 Β· predict.py</div>
<div class="step-title">Classical model predictions</div>
<div class="step-file">predict.py β predict_classical(text_clean, ds)</div>
</div>
</div>
<div class="what-box">
<div class="what-title">What happens β 3 steps inside this function</div>
<div class="what-body"><strong>1. TF-IDF transform:</strong> Converts the cleaned text into a vector of 50,000 numbers using the same vectoriser fitted during training.<br><br><strong>2. Model.predict:</strong> Each of the 3 classical models takes the vector and outputs a class index (e.g. 4 = "postpartum").<br><br><strong>3. Confidence score:</strong> Different method per model β LR and XGBoost use predict_proba(), SVM uses decision_function() converted via softmax.</div>
</div>
<div class="code-block"><span class="cm"># predict.py β called 3Γ (once per dataset)</span>
<span class="kw">def</span> <span class="fn">predict_classical</span>(text_clean, ds):
tfidf = _models[<span class="str">f'tfidf_{ds}'</span>]
le = _models[<span class="str">f'le_{ds}'</span>]
vec = tfidf.<span class="fn">transform</span>([text_clean]) <span class="cm"># text β 50K-dim vector</span>
<span class="kw">for</span> model_name <span class="kw">in</span> [<span class="str">'logistic_regression'</span>, <span class="str">'svm'</span>, <span class="str">'xgboost'</span>]:
model = _models[<span class="str">f'{model_name}_{ds}'</span>]
pred_idx = model.<span class="fn">predict</span>(vec)[<span class="num">0</span>] <span class="cm"># β e.g. 4</span>
label = le.classes_[pred_idx] <span class="cm"># 4 β "postpartum"</span>
<span class="cm"># LR / XGBoost: direct probability</span>
<span class="kw">if</span> <span class="fn">hasattr</span>(model, <span class="str">'predict_proba'</span>):
conf = model.<span class="fn">predict_proba</span>(vec)[<span class="num">0</span>][pred_idx]
<span class="cm"># SVM: no predict_proba β use softmax of decision scores</span>
<span class="kw">elif</span> <span class="fn">hasattr</span>(model, <span class="str">'decision_function'</span>):
scores = model.<span class="fn">decision_function</span>(vec)[<span class="num">0</span>]
e = np.<span class="fn">exp</span>(scores - scores.<span class="fn">max</span>())
conf = e[pred_idx] / e.<span class="fn">sum</span>() <span class="cm"># normalise to 0β1</span></div>
<div class="important-box imp-green">
<div class="imp-title">Why SVM needs special treatment</div>
SVM (LinearSVC) finds a decision boundary but does not model probabilities β it just says "which side of the line?" Converting decision_function scores with softmax gives a reasonable confidence proxy. It is not a true probability but works well enough for display.
</div>
<div class="nav-btns">
<button class="nav-btn" onclick="goTo(3)">β clean_text()</button>
<button class="nav-btn" onclick="goTo(5)">Next: XLM-RoBERTa β</button>
</div>
</div>
<!-- STEP 5 β XLM-RoBERTa -->
<div class="step-content" id="step5">
<div class="flow-mini">
<div class="flow-node">1β5 Β· Browser β classical</div><div class="flow-arrow">β</div>
<div class="flow-node active-node">6 Β· predict_xlmr()</div><div class="flow-arrow">β</div>
<div class="flow-node">7 Β· assemble</div>
</div>
<div class="step-header">
<div class="step-icon" style="background:var(--purple-bg)">π€</div>
<div>
<div class="step-num-big" style="color:var(--purple)">Step 06 Β· predict.py</div>
<div class="step-title">XLM-RoBERTa prediction</div>
<div class="step-file">predict.py β predict_xlmr(raw_text, model, le, max_len)</div>
</div>
</div>
<div class="what-box">
<div class="what-title">What happens β 4 steps</div>
<div class="what-body"><strong>1. Tokenise:</strong> The tokeniser splits text into sub-word pieces and converts them to integer IDs (e.g. "hopeless" might become [1234, 5678]).<br><br><strong>2. Forward pass:</strong> The 278M parameter model processes the token IDs and produces raw logit scores for each class.<br><br><strong>3. Softmax:</strong> Converts logits to proper probabilities that sum to 1.0.<br><br><strong>4. All class probs:</strong> Returns every class probability, not just the winner β this feeds the 6-class breakdown bars in Dataset 1.</div>
</div>
<div class="code-block"><span class="cm"># predict.py β called 3Γ (once per dataset)</span>
<span class="kw">def</span> <span class="fn">predict_xlmr</span>(raw_text, xlmr_model, le, max_len=<span class="num">128</span>):
inputs = tokenizer(
raw_text,
return_tensors=<span class="str">'pt'</span>, <span class="cm"># PyTorch tensors</span>
max_length=max_len, <span class="cm"># 128 for tweets, 256 for Reddit</span>
truncation=<span class="kw">True</span>,
padding=<span class="str">'max_length'</span>
).<span class="fn">to</span>(device) <span class="cm"># send to GPU if available</span>
<span class="kw">with</span> torch.<span class="fn">no_grad</span>(): <span class="cm"># no_grad saves memory (not training)</span>
logits = xlmr_model(**inputs).logits
probs = torch.<span class="fn">softmax</span>(logits, dim=<span class="num">1</span>)[<span class="num">0</span>] <span class="cm"># β [0.91, 0.04, 0.02, ...]</span>
pred_idx = <span class="fn">int</span>(probs.<span class="fn">argmax</span>()) <span class="cm"># index of highest</span>
label = le.classes_[pred_idx]
all_probs = {le.classes_[i]: <span class="fn">float</span>(p) <span class="kw">for</span> i, p <span class="kw">in</span> <span class="fn">enumerate</span>(probs)}
<span class="cm"># all_probs = {"postpartum":0.913, "bipolar":0.041, ...}</span>
<span class="cm"># only D1 uses this for the breakdown chart</span>
<span class="kw">return</span> {<span class="str">'label'</span>: label, <span class="str">'confidence'</span>: <span class="fn">float</span>(probs[pred_idx]), <span class="str">'all_probs'</span>: all_probs}</div>
<div class="important-box imp-purple">
<div class="imp-title">max_length differs per dataset</div>
D1 and D2 are tweets (avg 31 words β 40 tokens) β max_length=128. D3 is Reddit posts (avg 200 words β 260 tokens) β max_length=256. This doubles memory usage for D3, which is why batch_size was halved during training.
</div>
<div class="nav-btns">
<button class="nav-btn" onclick="goTo(4)">β Classical models</button>
<button class="nav-btn" onclick="goTo(6)">Next: predict_all() β</button>
</div>
</div>
<!-- STEP 6 β predict_all -->
<div class="step-content" id="step6">
<div class="flow-mini">
<div class="flow-node">1β6 Β· all models run</div><div class="flow-arrow">β</div>
<div class="flow-node active-node">7 Β· predict_all()</div><div class="flow-arrow">β</div>
<div class="flow-node">8 Β· JSON</div>
</div>
<div class="step-header">
<div class="step-icon" style="background:var(--green-bg)">π§</div>
<div>
<div class="step-num-big" style="color:var(--green)">Step 07 Β· predict.py</div>
<div class="step-title">predict_all() assembles everything</div>
<div class="step-file">predict.py β predict_all(raw_text) β the main function</div>
</div>
</div>
<div class="what-box">
<div class="what-title">What happens</div>
<div class="what-body">predict_all() is the orchestrator. It calls predict_classical() 3 times (once per dataset) and predict_xlmr() 3 times. Then it finds the winner per dataset (highest confidence), runs the suicide majority vote across D3's 4 models, and packages everything into a single JSON-ready dictionary.</div>
</div>
<div class="code-block"><span class="cm"># predict.py β the main function Flask calls</span>
<span class="kw">def</span> <span class="fn">predict_all</span>(raw_text):
clean = <span class="fn">clean_text</span>(raw_text)
<span class="cm"># Run all 4 models per dataset</span>
d1 = <span class="fn">predict_classical</span>(clean, <span class="str">'d1'</span>) <span class="cm"># β {LR:{}, SVM:{}, XGB:{}}</span>
d1[<span class="str">'XLM-RoBERTa'</span>] = <span class="fn">predict_xlmr</span>(raw_text, xlmr1, le1, <span class="num">128</span>)
<span class="cm"># same for d2, d3...</span>
<span class="cm"># Winner = model with highest confidence</span>
d1_winner = <span class="fn">max</span>(d1.items(), key=<span class="kw">lambda</span> x: x[<span class="num">1</span>][<span class="str">'confidence'</span>])
<span class="cm"># β ('XGBoost', {'label': 'postpartum', 'confidence': 0.999})</span>
<span class="cm"># Suicide risk = majority vote across 4 D3 models</span>
suicide_count = <span class="fn">sum</span>(
<span class="num">1</span> <span class="kw">for</span> r <span class="kw">in</span> d3.values()
<span class="kw">if</span> <span class="str">'suicide'</span> <span class="kw">in</span> r[<span class="str">'label'</span>] <span class="kw">and</span> <span class="str">'non'</span> <span class="kw">not in</span> r[<span class="str">'label'</span>]
)
risk_flag = suicide_count >= <span class="num">3</span> <span class="cm"># β₯3 of 4 models β HIGH RISK</span>
<span class="kw">return</span> {
<span class="str">'dataset1'</span>: {<span class="str">'models'</span>: d1, <span class="str">'winner_model'</span>: d1_winner[<span class="num">0</span>], ...},
<span class="str">'dataset2'</span>: {...},
<span class="str">'dataset3'</span>: {...},
<span class="str">'risk_flag'</span>: risk_flag,
<span class="str">'suicide_votes'</span>: <span class="str">f'{suicide_count}/4 models flagged'</span>
}</div>
<div class="important-box imp-red">
<div class="imp-title">The majority vote threshold β why 3 of 4?</div>
We chose 3/4 (75%) as the threshold for the high-risk alert. 2/4 (50%) would be too sensitive β a single false positive triggers an alert. 4/4 (100%) would be too strict β if one model misses it, no alert. 3/4 balances sensitivity against false alarms for a research prototype.
</div>
<div class="nav-btns">
<button class="nav-btn" onclick="goTo(5)">β XLM-RoBERTa</button>
<button class="nav-btn" onclick="goTo(7)">Next: JSON response β</button>
</div>
</div>
<!-- STEP 7 β JSON response -->
<div class="step-content" id="step7">
<div class="flow-mini">
<div class="flow-node">1β7 Β· All predictions done</div><div class="flow-arrow">β</div>
<div class="flow-node active-node">8 Β· JSON response</div><div class="flow-arrow">β</div>
<div class="flow-node">9β10 Β· UI renders</div>
</div>
<div class="step-header">
<div class="step-icon" style="background:var(--amber-bg)">π¦</div>
<div>
<div class="step-num-big" style="color:var(--amber)">Step 08 Β· app.py β browser</div>
<div class="step-title">JSON sent back to browser</div>
<div class="step-file">app.py β jsonify(result) β HTTP 200 response</div>
</div>
</div>
<div class="what-box">
<div class="what-title">What the browser receives</div>
<div class="what-body">Flask wraps the predict_all() result in a JSON HTTP response. The browser's fetch() receives this and parses it. The structure below is exactly what flows into the render() function next.</div>
</div>
<div class="code-block">{
<span class="str">"dataset1"</span>: {
<span class="str">"task"</span>: <span class="str">"Depression Type (6 Classes)"</span>,
<span class="str">"models"</span>: {
<span class="str">"Logistic Regression"</span>: { <span class="str">"label"</span>: <span class="str">"postpartum"</span>, <span class="str">"confidence"</span>: <span class="num">0.958</span> },
<span class="str">"SVM"</span>: { <span class="str">"label"</span>: <span class="str">"postpartum"</span>, <span class="str">"confidence"</span>: <span class="num">0.828</span> },
<span class="str">"XGBoost"</span>: { <span class="str">"label"</span>: <span class="str">"postpartum"</span>, <span class="str">"confidence"</span>: <span class="num">0.999</span> },
<span class="str">"XLM-RoBERTa"</span>: { <span class="str">"label"</span>: <span class="str">"postpartum"</span>, <span class="str">"confidence"</span>: <span class="num">0.997</span> }
},
<span class="str">"winner_model"</span>: <span class="str">"XGBoost"</span>,
<span class="str">"winner_prediction"</span>: <span class="str">"postpartum"</span>,
<span class="str">"winner_confidence"</span>: <span class="num">0.999</span>,
<span class="str">"class_probs"</span>: { <span class="str">"postpartum"</span>: <span class="num">0.997</span>, <span class="str">"bipolar"</span>: <span class="num">0.001</span>, ... }
},
<span class="str">"dataset2"</span>: { ... },
<span class="str">"dataset3"</span>: { ... },
<span class="str">"risk_flag"</span>: <span class="kw">false</span>,
<span class="str">"suicide_votes"</span>: <span class="str">"0/4 models flagged suicide risk"</span>,
<span class="str">"processing_time_ms"</span>: <span class="num">2341</span>
}</div>
<div class="nav-btns">
<button class="nav-btn" onclick="goTo(6)">β predict_all()</button>
<button class="nav-btn" onclick="goTo(8)">Next: render() β</button>
</div>
</div>
<!-- STEP 8 β render -->
<div class="step-content" id="step8">
<div class="flow-mini">
<div class="flow-node">1β8 Β· JSON received</div><div class="flow-arrow">β</div>
<div class="flow-node active-node">9 Β· render() + buildPanel()</div><div class="flow-arrow">β</div>
<div class="flow-node">10 Β· CSS animation</div>
</div>
<div class="step-header">
<div class="step-icon" style="background:var(--blue-bg)">π¨</div>
<div>
<div class="step-num-big" style="color:var(--blue)">Step 09 Β· index.html</div>
<div class="step-title">render() draws the results</div>
<div class="step-file">index.html β render(data) β buildPanel() Γ 3</div>
</div>
</div>
<div class="what-box">
<div class="what-title">What happens</div>
<div class="what-body">render() fills in the three winner cards (depression type, depressed?, suicide risk) and then calls buildPanel() three times β once per dataset β to build the model comparison rows. Each row shows the model name, its prediction, a confidence bar, and a β
if it's the winner.</div>
</div>
<div class="code-block"><span class="cm">// index.html β called after fetch() returns</span>
<span class="kw">function</span> <span class="fn">render</span>(d, text) {
<span class="cm">// 1. Fill winner cards</span>
document.<span class="fn">getElementById</span>(<span class="str">'wpA'</span>).textContent = d.dataset1.winner_prediction;
document.<span class="fn">getElementById</span>(<span class="str">'wcA'</span>).textContent = (d.dataset1.winner_confidence * <span class="num">100</span>).<span class="fn">toFixed</span>(<span class="num">1</span>) + <span class="str">'%'</span>;
<span class="cm">// 2. Build per-model rows for each dataset</span>
<span class="fn">buildPanel</span>(<span class="str">'p1'</span>, d.dataset1.models, d.dataset1.winner_model);
<span class="fn">buildPanel</span>(<span class="str">'p2'</span>, d.dataset2.models, d.dataset2.winner_model);
<span class="fn">buildPanel</span>(<span class="str">'p3'</span>, d.dataset3.models, d.dataset3.winner_model);
<span class="cm">// 3. Risk banner</span>
<span class="kw">if</span> (d.risk_flag) {
riskBanner.className = <span class="str">'risk-banner danger'</span>;
} <span class="kw">else</span> {
riskBanner.className = <span class="str">'risk-banner safe'</span>;
}
<span class="cm">// 4. Show results section</span>
document.<span class="fn">getElementById</span>(<span class="str">'results'</span>).style.display = <span class="str">'block'</span>;
}
<span class="kw">function</span> <span class="fn">buildPanel</span>(panelId, models, winner) {
<span class="kw">let</span> html = <span class="str">''</span>;
<span class="cls">Object</span>.<span class="fn">entries</span>(models).<span class="fn">forEach</span>(([name, res]) => {
html += <span class="str">`<div class="mr ${name===winner?'winner':''}">
<div class="mr-name">${name}</div>
<div class="mr-pred">${res.label}</div>
<div class="mr-fill" data-w="${(res.confidence*100).toFixed(1)}"></div>
<div class="mr-pct">${(res.confidence*100).toFixed(1)}%</div>
</div>`</span>;
});
panel.innerHTML = html; <span class="cm">// inject HTML</span>
<span class="cm">// bars animate next step β</span>
}</div>
<div class="nav-btns">
<button class="nav-btn" onclick="goTo(7)">β JSON response</button>
<button class="nav-btn" onclick="goTo(9)">Next: CSS animation β</button>
</div>
</div>
<!-- STEP 9 β CSS animation -->
<div class="step-content" id="step9">
<div class="flow-mini">
<div class="flow-node">1β9 Β· HTML rows created</div><div class="flow-arrow">β</div>
<div class="flow-node active-node">10 Β· CSS animation</div>
</div>
<div class="step-header">
<div class="step-icon" style="background:var(--blue-bg)">β¨</div>
<div>
<div class="step-num-big" style="color:var(--blue)">Step 10 Β· index.html + CSS</div>
<div class="step-title">Confidence bars animate</div>
<div class="step-file">setTimeout(80ms) β style.width β CSS transition</div>
</div>
</div>
<div class="what-box">
<div class="what-title">What happens</div>
<div class="what-body">The bars are created with <strong>width: 0%</strong>. An 80ms delay gives the browser time to paint the DOM first. Then JavaScript sets each bar's width from its <strong>data-w attribute</strong> (e.g. "82.8"). The CSS <strong>transition</strong> property smoothly animates from 0% β 82.8% over 0.8 seconds. That's the fill animation you see.</div>
</div>
<div class="code-block"><span class="cm">/* CSS β transition defined in <style> */</span>
.mr-fill {
width: <span class="num">0%</span>; <span class="cm">/* starts invisible */</span>
<span class="kw">transition</span>: width <span class="num">0.8s</span> cubic-bezier(.4,0,.2,1); <span class="cm">/* smooth ease-out */</span>
}
.mr.winner .mr-fill { background: var(--purple); } <span class="cm">/* winner = purple */</span>
<span class="cm">// JavaScript β in buildPanel()</span>
<span class="fn">setTimeout</span>(() => {
panel.<span class="fn">querySelectorAll</span>(<span class="str">'.mr-fill'</span>).<span class="fn">forEach</span>(el => {
el.style.width = el.<span class="fn">getAttribute</span>(<span class="str">'data-w'</span>) + <span class="str">'%'</span>;
<span class="cm">// sets e.g. "82.8%" β CSS transition plays automatically</span>
});
}, <span class="num">80</span>); <span class="cm">// 80ms wait for DOM to paint first</span>
<span class="cm">// The 6-class breakdown bars work the same way</span>
<span class="cm">// but use 200ms delay and .cp-fill class</span></div>
<div class="important-box imp-blue">
<div class="imp-title">Why the 80ms delay?</div>
If you set style.width immediately after setting innerHTML, the browser hasn't painted the elements yet. The transition has nothing to "from" β the bars jump to their final width instantly with no animation. The 80ms gives the browser one render frame to establish the 0% starting state, so the transition has a clean start point.
</div>
<div class="returns-box">
<div class="ret-title">Complete flow summary</div>
<div class="ret-row"><div class="ret-key">Total round trip time</div><div class="ret-val">~2β4 seconds (dominated by XLM-RoBERTa inference on CPU)</div></div>
<div class="ret-row"><div class="ret-key">Files involved</div><div class="ret-val">index.html β app.py β predict.py β back to index.html</div></div>
<div class="ret-row"><div class="ret-key">Models called</div><div class="ret-val">12 total: LR + SVM + XGBoost + XLM-R Γ 3 datasets</div></div>
<div class="ret-row"><div class="ret-key">Winner selection</div><div class="ret-val">Highest confidence per dataset β pure Python max()</div></div>
<div class="ret-row"><div class="ret-key">Risk flag</div><div class="ret-val">Majority vote β β₯3 of 4 Dataset 3 models predict "suicide"</div></div>
</div>
<div class="nav-btns">
<button class="nav-btn" onclick="goTo(8)">β render()</button>
<button class="nav-btn" onclick="goTo(0)">β Start over</button>
</div>
</div>
</div>
</div>
<script>
function goTo(n) {
document.querySelectorAll('.step-content').forEach((el,i) => {
el.classList.toggle('active', i === n);
});
document.querySelectorAll('.step-btn').forEach((el,i) => {
el.classList.toggle('active', i === n);
});
document.querySelector('.main').scrollTop = 0;
window.scrollTo(0, 0);
}
</script>
</body>
</html> |