Spaces:
Sleeping
Sleeping
File size: 34,602 Bytes
34a1c85 |
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 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 |
{
"cells": [
{
"cell_type": "markdown",
"id": "e2192e55",
"metadata": {},
"source": [
"# Project: CCSS Standard Alignment using BM25 and SPLADE\n",
"\n",
"---\n",
"\n",
"## Background\n",
"\n",
"### BM25 (Best Matching 25)\n",
"\n",
"BM25 is a **traditional lexical retrieval model** used in information retrieval systems (like search engines). It ranks documents based on the **term frequencyβinverse document frequency (TF-IDF)** concept, with additional normalization for document length.\n",
"\n",
"**Core Characteristics:**\n",
"- Lexical-only: matches exact words (not synonyms/paraphrases)\n",
"- Scores documents using a tunable function of:\n",
" - **Term frequency (TF)** β how often a query term appears in the doc\n",
" - **Inverse Document Frequency (IDF)** β how rare the term is overall\n",
" - **Document length normalization**\n",
"- Fast and interpretable\n",
"\n",
"**Strengths:**\n",
"- Simple and fast\n",
"- Strong for keyword-heavy queries\n",
"- Works well on small datasets\n",
"\n",
"**Limitations:**\n",
"- Cannot understand synonyms, rephrasing, or context\n",
"\n",
"---\n",
"\n",
"### SPLADE (Sparse Lexical and Expansion Model)\n",
"\n",
"SPLADE is a **neural sparse retriever** that combines the **interpretability of sparse vectors** with the **semantic power of transformers (like BERT)**.\n",
"\n",
"**How it works:**\n",
"- Instead of dense embeddings (like BERT or SBERT), SPLADE generates **sparse term-weighted vectors**\n",
"- These vectors can:\n",
" - Activate terms **not explicitly in the query** (semantic expansion)\n",
" - Assign importance scores to vocabulary terms\n",
"- Supports use of **inverted indexes** like BM25, but with neural knowledge\n",
"\n",
"**Strengths:**\n",
"- Captures paraphrasing and synonyms\n",
"- Sparse and interpretable\n",
"- Works better on natural language queries\n",
"\n",
"**Limitations:**\n",
"- Slower than BM25\n",
"- Requires GPU for efficient inference\n",
"\n",
"---\n",
"\n",
"## Project Overview\n",
"\n",
"### Goal:\n",
"\n",
"Build a system that **automatically aligns educational content (e.g., lesson descriptions, learning objectives)** to the most relevant **Common Core State Standards (CCSS)** for English Language Arts (ELA).\n",
"\n",
"---\n",
"\n",
"### Approach:\n",
"\n",
"We implement and compare **two retrieval pipelines**:\n",
"\n",
"| Component | Pipeline 1 | Pipeline 2 |\n",
"|---------------|----------------------|------------------------|\n",
"| Model | BM25 | SPLADE |\n",
"| Representation | Token frequency | Sparse transformer weights |\n",
"| Input | Free-form text | Free-form text |\n",
"| Output | Top-N most relevant CCSS standards with scores |\n",
"\n",
"---\n",
"\n",
"### Dataset:\n",
"\n",
"- Source: `CCSS Common Core Standards.xlsx`\n",
"- Focus: Only **ELA standards**\n",
"- Fields used: `ID`, `Sub Category`, `State Standard`\n",
"\n",
"---\n",
"\n",
"### Output Format:\n",
"\n",
"Each pipeline returns a list of matches:\n",
"```json\n",
"[\n",
" {\n",
" \"rank\": 1,\n",
" \"score\": 10.87,\n",
" \"ID\": \"4.RI.2\",\n",
" \"Category\": \"Reading Informational\",\n",
" \"Sub Category\": \"Key Ideas and Details\",\n",
" \"State Standard\": \"Determine the main idea of a text...\"\n",
" },\n",
" ...\n",
"]\n"
]
},
{
"cell_type": "code",
"execution_count": 28,
"id": "cfa8b1b6",
"metadata": {},
"outputs": [],
"source": [
"import pandas as pd\n",
"import re\n",
"from nltk.tokenize import word_tokenize\n",
"from nltk.corpus import stopwords\n",
"from nltk.stem import WordNetLemmatizer"
]
},
{
"cell_type": "code",
"execution_count": 46,
"id": "748918e3",
"metadata": {},
"outputs": [],
"source": [
"stop_words = set(stopwords.words('english'))"
]
},
{
"cell_type": "code",
"execution_count": 62,
"id": "3cf17d78",
"metadata": {},
"outputs": [],
"source": [
"df = pd.read_csv('/Users/shivendragupta/Desktop/internship25/CCSS/data/CCSS Common Core Standards(English Standards).csv')"
]
},
{
"cell_type": "code",
"execution_count": 63,
"id": "ee2b47e5",
"metadata": {},
"outputs": [
{
"data": {
"text/html": [
"<div>\n",
"<style scoped>\n",
" .dataframe tbody tr th:only-of-type {\n",
" vertical-align: middle;\n",
" }\n",
"\n",
" .dataframe tbody tr th {\n",
" vertical-align: top;\n",
" }\n",
"\n",
" .dataframe thead th {\n",
" text-align: right;\n",
" }\n",
"</style>\n",
"<table border=\"1\" class=\"dataframe\">\n",
" <thead>\n",
" <tr style=\"text-align: right;\">\n",
" <th></th>\n",
" <th>ID</th>\n",
" <th>Category</th>\n",
" <th>Sub Category</th>\n",
" <th>State Standard</th>\n",
" </tr>\n",
" </thead>\n",
" <tbody>\n",
" <tr>\n",
" <th>0</th>\n",
" <td>K.RL.1</td>\n",
" <td>Reading Literature</td>\n",
" <td>Key Ideas and Details</td>\n",
" <td>With prompting and support, ask and answer que...</td>\n",
" </tr>\n",
" <tr>\n",
" <th>1</th>\n",
" <td>K.RL.2</td>\n",
" <td>Reading Literature</td>\n",
" <td>Key Ideas and Details</td>\n",
" <td>With prompting and support, retell familiar st...</td>\n",
" </tr>\n",
" <tr>\n",
" <th>2</th>\n",
" <td>K.RL.3</td>\n",
" <td>Reading Literature</td>\n",
" <td>Key Ideas and Details</td>\n",
" <td>With prompting and support, identify character...</td>\n",
" </tr>\n",
" <tr>\n",
" <th>3</th>\n",
" <td>K.RL.4</td>\n",
" <td>Reading Literature</td>\n",
" <td>Craft and Structure</td>\n",
" <td>Ask and answer questions about unknown words i...</td>\n",
" </tr>\n",
" <tr>\n",
" <th>4</th>\n",
" <td>K.RL.5</td>\n",
" <td>Reading Literature</td>\n",
" <td>Craft and Structure</td>\n",
" <td>Recognize common types of texts (e.g., storybo...</td>\n",
" </tr>\n",
" </tbody>\n",
"</table>\n",
"</div>"
],
"text/plain": [
" ID Category Sub Category \\\n",
"0 K.RL.1 Reading Literature Key Ideas and Details \n",
"1 K.RL.2 Reading Literature Key Ideas and Details \n",
"2 K.RL.3 Reading Literature Key Ideas and Details \n",
"3 K.RL.4 Reading Literature Craft and Structure \n",
"4 K.RL.5 Reading Literature Craft and Structure \n",
"\n",
" State Standard \n",
"0 With prompting and support, ask and answer que... \n",
"1 With prompting and support, retell familiar st... \n",
"2 With prompting and support, identify character... \n",
"3 Ask and answer questions about unknown words i... \n",
"4 Recognize common types of texts (e.g., storybo... "
]
},
"execution_count": 63,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"df.head() # Display the first few rows of the DataFrame"
]
},
{
"cell_type": "code",
"execution_count": 64,
"id": "3958653b",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"(1486, 4)"
]
},
"execution_count": 64,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"df.shape"
]
},
{
"cell_type": "code",
"execution_count": 65,
"id": "0e747290",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"ID 501\n",
"Category 501\n",
"Sub Category 501\n",
"State Standard 501\n",
"dtype: int64"
]
},
"execution_count": 65,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"df.isna().sum()"
]
},
{
"cell_type": "code",
"execution_count": 66,
"id": "34001c04",
"metadata": {},
"outputs": [],
"source": [
"df.dropna(inplace=True) # Drop rows with any NaN values"
]
},
{
"cell_type": "markdown",
"id": "5e02750b",
"metadata": {},
"source": [
"# ```Preprocessing data```"
]
},
{
"cell_type": "code",
"execution_count": 67,
"id": "506a332c",
"metadata": {},
"outputs": [],
"source": [
"def clean_text(text: str) -> str:\n",
" text = text.strip()\n",
" text = text.replace(\"\\n\", \" \").replace(\"\\xa0\", \" \")\n",
" text = text.replace(\"β\", \"\\\"\").replace(\"β\", \"\\\"\").replace(\"β\", \"-\")\n",
" return text"
]
},
{
"cell_type": "markdown",
"id": "a97a9cfb",
"metadata": {},
"source": [
"## ```Lower Casing```"
]
},
{
"cell_type": "code",
"execution_count": 38,
"id": "2f843d49",
"metadata": {},
"outputs": [],
"source": [
"def lowercase(text: str) -> str:\n",
" return text.lower()"
]
},
{
"cell_type": "markdown",
"id": "4bc931f1",
"metadata": {},
"source": [
"## ```Removing Punctuation```"
]
},
{
"cell_type": "code",
"execution_count": 39,
"id": "734d4b30",
"metadata": {},
"outputs": [],
"source": [
"def remove_punctuation(text: str) -> str:\n",
" return re.sub(r\"[^\\w\\s]\", \"\", text)"
]
},
{
"cell_type": "markdown",
"id": "d12ab012",
"metadata": {},
"source": [
"## ``` Removing Stop Words ```"
]
},
{
"cell_type": "code",
"execution_count": 49,
"id": "b925980c",
"metadata": {},
"outputs": [],
"source": [
"def remove_stopwords(text: str) -> str:\n",
" tokens = word_tokenize(text)\n",
" return ' '.join([word for word in tokens if word not in stop_words])"
]
},
{
"cell_type": "markdown",
"id": "814c3818",
"metadata": {},
"source": [
"## ``` Lemmatization ```"
]
},
{
"cell_type": "code",
"execution_count": 41,
"id": "70500704",
"metadata": {},
"outputs": [],
"source": [
"lemmatizer = WordNetLemmatizer()"
]
},
{
"cell_type": "code",
"execution_count": 50,
"id": "7e287fc2",
"metadata": {},
"outputs": [],
"source": [
"def lemmatize_tokens(text: str) -> str:\n",
" tokens = word_tokenize(text)\n",
" return ' '.join([lemmatizer.lemmatize(token) for token in tokens])\n"
]
},
{
"cell_type": "markdown",
"id": "39bd33a6",
"metadata": {},
"source": [
"## ``` PipeLine ```"
]
},
{
"cell_type": "code",
"execution_count": 68,
"id": "b443ffec",
"metadata": {},
"outputs": [],
"source": [
"def preprocessing_pipeline(text: str) -> str:\n",
" text = clean_text(text)\n",
" text = lowercase(text)\n",
" text = remove_punctuation(text)\n",
" text = remove_stopwords(text)\n",
" text = lemmatize_tokens(text)\n",
" return text"
]
},
{
"cell_type": "code",
"execution_count": 69,
"id": "13a7d65a",
"metadata": {},
"outputs": [],
"source": [
"df['State Standard'] = df['State Standard'].apply(preprocessing_pipeline)"
]
},
{
"cell_type": "code",
"execution_count": 70,
"id": "f5a8cb5d",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"0 prompting support ask answer question key deta...\n",
"1 prompting support retell familiar story includ...\n",
"2 prompting support identify character setting m...\n",
"3 ask answer question unknown word text\n",
"4 recognize common type text eg storybook poem\n",
" ... \n",
"980 use technology including internet produce publ...\n",
"981 conduct short well sustained research project ...\n",
"982 gather relevant information multiple authorita...\n",
"983 draw evidence informational text support analy...\n",
"984 write routinely extended time frame time refle...\n",
"Name: State Standard, Length: 985, dtype: object"
]
},
"execution_count": 70,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"df['State Standard']"
]
},
{
"cell_type": "markdown",
"id": "ecb1369e",
"metadata": {},
"source": [
"## ``` BM25 Retreiver Function ```"
]
},
{
"cell_type": "code",
"execution_count": 73,
"id": "41e30b91",
"metadata": {},
"outputs": [],
"source": [
"from rank_bm25 import BM25Okapi"
]
},
{
"cell_type": "code",
"execution_count": 74,
"id": "d34de1f1",
"metadata": {},
"outputs": [],
"source": [
"tokenized_docs = [doc.lower().split() for doc in df['State Standard']]"
]
},
{
"cell_type": "code",
"execution_count": 77,
"id": "32594e27",
"metadata": {},
"outputs": [],
"source": [
"bm25 = BM25Okapi(tokenized_docs)"
]
},
{
"cell_type": "code",
"execution_count": 155,
"id": "3d552a24",
"metadata": {},
"outputs": [],
"source": [
"def retrieve_top_n_bm25(query: str, top_n=5):\n",
" query_tokens = preprocessing_pipeline(query)\n",
" tokenized_query = query_tokens.split()\n",
" \n",
" scores = bm25.get_scores(tokenized_query)\n",
"\n",
" top_indices = sorted(range(len(scores)), key=lambda i: scores[i], reverse=True)[:top_n]\n",
"\n",
"\n",
" # ID\tCategory\tSub Category\tState Standard\n",
"\n",
" results = []\n",
" for idx in top_indices:\n",
" row = df.iloc[idx]\n",
" results.append({\n",
" \"ID\": row[\"ID\"],\n",
" \"Category\": row[\"Category\"],\n",
" \"Sub Category\": row[\"Sub Category\"],\n",
" \"standard\": row[\"State Standard\"],\n",
" \"score\": round(scores[idx], 4)\n",
"\n",
" })\n",
" return results\n"
]
},
{
"cell_type": "code",
"execution_count": 123,
"id": "5a18deb6",
"metadata": {},
"outputs": [],
"source": [
"query = \"Identify the main idea of a text\""
]
},
{
"cell_type": "code",
"execution_count": 124,
"id": "11954a8a",
"metadata": {},
"outputs": [],
"source": [
"results = retrieve_top_n_bm25(query, top_n=5)"
]
},
{
"cell_type": "markdown",
"id": "49538e11",
"metadata": {},
"source": [
"## ``` Top 5 Results from BM25 Retrieval ```"
]
},
{
"cell_type": "code",
"execution_count": 125,
"id": "f7d12c4d",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"[{'ID': '1.RI.2',\n",
" 'Category': 'Reading Informational',\n",
" 'Sub Category': 'Key Ideas and Details',\n",
" 'State Standard': 'identify main topic retell key detail text',\n",
" 'score': 10.666},\n",
" {'ID': '3.RI.2',\n",
" 'Category': 'Reading Informational',\n",
" 'Sub Category': 'Key Ideas and Details',\n",
" 'State Standard': 'determine main idea text recount key detail explain support main idea',\n",
" 'score': 10.0953},\n",
" {'ID': 'K.RI.2',\n",
" 'Category': 'Reading Informational',\n",
" 'Sub Category': 'Key Ideas and Details',\n",
" 'State Standard': 'prompting support identify main topic retell key detail text',\n",
" 'score': 9.8043},\n",
" {'ID': '2.RI.6',\n",
" 'Category': 'Reading Informational',\n",
" 'Sub Category': 'Craft and Structure',\n",
" 'State Standard': 'identify main purpose text including author want answer explain describe',\n",
" 'score': 9.4236},\n",
" {'ID': '2.RI.2',\n",
" 'Category': 'Reading Informational',\n",
" 'Sub Category': 'Key Ideas and Details',\n",
" 'State Standard': 'identify main topic multiparagraph text well focus specific paragraph within text',\n",
" 'score': 9.3944}]"
]
},
"execution_count": 125,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"results"
]
},
{
"cell_type": "markdown",
"id": "1dd7ac6e",
"metadata": {},
"source": [
"## ``` Using Splade sparse retreiver```"
]
},
{
"cell_type": "code",
"execution_count": 126,
"id": "f8c3fee3",
"metadata": {},
"outputs": [
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "be42ffa9ef0949679ea06670a3436378",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
"tokenizer_config.json: 0%| | 0.00/466 [00:00<?, ?B/s]"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "e638218262224627be57d394b0bb8d07",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
"vocab.txt: 0.00B [00:00, ?B/s]"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "448331ce71bf4b98b07f0291f734fd97",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
"tokenizer.json: 0.00B [00:00, ?B/s]"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "0b4b7108d21c44ca96368b6b6f137002",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
"special_tokens_map.json: 0%| | 0.00/112 [00:00<?, ?B/s]"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "1f86b5b8152645bcb5318b15d57243d8",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
"config.json: 0%| | 0.00/670 [00:00<?, ?B/s]"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "d9e4d08d968e4a6a8bd93476a68e1f83",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
"pytorch_model.bin: 0%| | 0.00/438M [00:00<?, ?B/s]"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"text/plain": [
"BertForMaskedLM(\n",
" (bert): BertModel(\n",
" (embeddings): BertEmbeddings(\n",
" (word_embeddings): Embedding(30522, 768, padding_idx=0)\n",
" (position_embeddings): Embedding(512, 768)\n",
" (token_type_embeddings): Embedding(2, 768)\n",
" (LayerNorm): LayerNorm((768,), eps=1e-12, elementwise_affine=True)\n",
" (dropout): Dropout(p=0.1, inplace=False)\n",
" )\n",
" (encoder): BertEncoder(\n",
" (layer): ModuleList(\n",
" (0-11): 12 x BertLayer(\n",
" (attention): BertAttention(\n",
" (self): BertSdpaSelfAttention(\n",
" (query): Linear(in_features=768, out_features=768, bias=True)\n",
" (key): Linear(in_features=768, out_features=768, bias=True)\n",
" (value): Linear(in_features=768, out_features=768, bias=True)\n",
" (dropout): Dropout(p=0.1, inplace=False)\n",
" )\n",
" (output): BertSelfOutput(\n",
" (dense): Linear(in_features=768, out_features=768, bias=True)\n",
" (LayerNorm): LayerNorm((768,), eps=1e-12, elementwise_affine=True)\n",
" (dropout): Dropout(p=0.1, inplace=False)\n",
" )\n",
" )\n",
" (intermediate): BertIntermediate(\n",
" (dense): Linear(in_features=768, out_features=3072, bias=True)\n",
" (intermediate_act_fn): GELUActivation()\n",
" )\n",
" (output): BertOutput(\n",
" (dense): Linear(in_features=3072, out_features=768, bias=True)\n",
" (LayerNorm): LayerNorm((768,), eps=1e-12, elementwise_affine=True)\n",
" (dropout): Dropout(p=0.1, inplace=False)\n",
" )\n",
" )\n",
" )\n",
" )\n",
" )\n",
" (cls): BertOnlyMLMHead(\n",
" (predictions): BertLMPredictionHead(\n",
" (transform): BertPredictionHeadTransform(\n",
" (dense): Linear(in_features=768, out_features=768, bias=True)\n",
" (transform_act_fn): GELUActivation()\n",
" (LayerNorm): LayerNorm((768,), eps=1e-12, elementwise_affine=True)\n",
" )\n",
" (decoder): Linear(in_features=768, out_features=30522, bias=True)\n",
" )\n",
" )\n",
")"
]
},
"execution_count": 126,
"metadata": {},
"output_type": "execute_result"
},
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "afa41fd273a147f08a2017dad5455866",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
"model.safetensors: 0%| | 0.00/438M [00:00<?, ?B/s]"
]
},
"metadata": {},
"output_type": "display_data"
}
],
"source": [
"from transformers import AutoTokenizer, AutoModelForMaskedLM\n",
"import torch\n",
"import torch.nn.functional as F\n",
"\n",
"model_name = \"naver/splade-cocondenser-ensembledistil\"\n",
"tokenizer = AutoTokenizer.from_pretrained(model_name)\n",
"model = AutoModelForMaskedLM.from_pretrained(model_name)\n",
"model.eval()\n"
]
},
{
"cell_type": "code",
"execution_count": 127,
"id": "0dcffefe",
"metadata": {},
"outputs": [],
"source": [
"def get_splade_sparse_vector(text):\n",
" with torch.no_grad():\n",
" inputs = tokenizer(text, return_tensors=\"pt\", truncation=True, max_length=512)\n",
" logits = model(**inputs).logits.squeeze(0) # [seq_len, vocab_size]\n",
" relu_out = F.relu(logits)\n",
" splade_weights = torch.log1p(relu_out).max(dim=0).values\n",
" indices = torch.nonzero(splade_weights).squeeze()\n",
" return {\n",
" tokenizer.convert_ids_to_tokens([i.item()])[0]: splade_weights[i].item()\n",
" for i in indices\n",
" }\n"
]
},
{
"cell_type": "code",
"execution_count": 128,
"id": "0493ae98",
"metadata": {},
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"100%|ββββββββββ| 985/985 [00:39<00:00, 24.77it/s]\n"
]
}
],
"source": [
"from tqdm import tqdm\n",
"\n",
"# Reset index to align doc IDs\n",
"df = df.reset_index(drop=True)\n",
"\n",
"# Get list of standard texts\n",
"standard_texts = df[\"State Standard\"].astype(str).tolist()\n",
"\n",
"# Compute sparse vectors\n",
"splade_doc_vectors = [get_splade_sparse_vector(text) for text in tqdm(standard_texts)]\n"
]
},
{
"cell_type": "code",
"execution_count": 129,
"id": "42c8b47b",
"metadata": {},
"outputs": [],
"source": [
"def dot_product_sparse(query_vec, doc_vec):\n",
" return sum(query_vec.get(term, 0.0) * doc_vec.get(term, 0.0) for term in query_vec)\n"
]
},
{
"cell_type": "code",
"execution_count": 131,
"id": "6254a5e9",
"metadata": {},
"outputs": [],
"source": [
"def retrieve_top_n_splade(query, top_n=5):\n",
" query_vec = get_splade_sparse_vector(query)\n",
" scores = [\n",
" (dot_product_sparse(query_vec, doc_vec), idx)\n",
" for idx, doc_vec in enumerate(splade_doc_vectors)\n",
" ]\n",
" \n",
" top_matches = sorted(scores, reverse=True)[:top_n]\n",
" \n",
" results = []\n",
" for score, idx in top_matches:\n",
" results.append({\n",
" \"rank\": len(results) + 1,\n",
" \"score\": round(score, 4),\n",
" \"standard\": df.iloc[idx][\"State Standard\"],\n",
" \"ID\": df.iloc[idx][\"ID\"],\n",
" \"Category\": df.iloc[idx][\"Category\"],\n",
" \"Sub Category\": df.iloc[idx][\"Sub Category\"]\n",
" })\n",
" return results\n"
]
},
{
"cell_type": "code",
"execution_count": 146,
"id": "26f27920",
"metadata": {},
"outputs": [],
"source": [
"query = \"Identify the main idea of a text\"\n",
"results = retrieve_top_n_splade(query)\n"
]
},
{
"cell_type": "code",
"execution_count": 147,
"id": "6f736b83",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"[{'rank': 1,\n",
" 'score': 21.3089,\n",
" 'standard': 'determine main idea text explain supported key detail summarize text',\n",
" 'ID': '4.RI.2',\n",
" 'Category': 'Reading Informational',\n",
" 'Sub Category': 'Key Ideas and Details'},\n",
" {'rank': 2,\n",
" 'score': 20.8493,\n",
" 'standard': 'determine main idea text recount key detail explain support main idea',\n",
" 'ID': '3.RI.2',\n",
" 'Category': 'Reading Informational',\n",
" 'Sub Category': 'Key Ideas and Details'},\n",
" {'rank': 3,\n",
" 'score': 20.2714,\n",
" 'standard': 'determine two main idea text explain supported key detail summarize text',\n",
" 'ID': '5.RI.2',\n",
" 'Category': 'Reading Informational',\n",
" 'Sub Category': 'Key Ideas and Details'},\n",
" {'rank': 4,\n",
" 'score': 17.5151,\n",
" 'standard': 'determine main idea supporting detail text read aloud information presented diverse medium format including visually quantitatively orally',\n",
" 'ID': '3.SL.2',\n",
" 'Category': 'Speaking & Listening',\n",
" 'Sub Category': 'Comprehension and Collaboration'},\n",
" {'rank': 5,\n",
" 'score': 17.512,\n",
" 'standard': 'identify main purpose text including author want answer explain describe',\n",
" 'ID': '2.RI.6',\n",
" 'Category': 'Reading Informational',\n",
" 'Sub Category': 'Craft and Structure'}]"
]
},
"execution_count": 147,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"results"
]
},
{
"cell_type": "code",
"execution_count": 148,
"id": "f6232e19",
"metadata": {},
"outputs": [],
"source": [
"def evaluate_top1_accuracy(df, retrieve_fn):\n",
" correct = 0\n",
" total = len(df)\n",
"\n",
" for i in range(total):\n",
" query = df.loc[i, \"State Standard\"]\n",
" expected = query.strip().lower()\n",
"\n",
" results = retrieve_fn(query, top_n=1)\n",
" predicted = results[0][\"standard\"].strip().lower()\n",
"\n",
" if predicted == expected:\n",
" correct += 1\n",
"\n",
" accuracy = round(correct / total, 4)\n",
" print(f\"Top-1 Accuracy: {accuracy}\")\n",
" return accuracy\n"
]
},
{
"cell_type": "code",
"execution_count": 156,
"id": "5d653426",
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Top-1 Accuracy: 0.9959\n"
]
},
{
"data": {
"text/plain": [
"0.9959"
]
},
"execution_count": 156,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"# For BM25\n",
"evaluate_top1_accuracy(df, retrieve_top_n_bm25)"
]
},
{
"cell_type": "code",
"execution_count": 153,
"id": "6f9e5c59",
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Top-1 Accuracy: 0.9797\n"
]
},
{
"data": {
"text/plain": [
"0.9797"
]
},
"execution_count": 153,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"# For SPLADE\n",
"evaluate_top1_accuracy(df, retrieve_top_n_splade)\n"
]
},
{
"cell_type": "markdown",
"id": "a2b5800b",
"metadata": {},
"source": [
"## Comparison: BM25 vs SPLADE for CCSS Alignment\n",
"\n",
"**Query:** \n",
"> *\"Identify the main idea of a text\"*\n",
"\n",
"---\n",
"\n",
"### Top-5 Results: **BM25**\n",
"\n",
"| Rank | ID | Category | Sub Category | State Standard | Score |\n",
"|------|---------|----------------------|----------------------|----------------------------------------------------------------------------------|---------|\n",
"| 1 | 1.RI.2 | Reading Informational| Key Ideas and Details| identify main topic retell key detail text | 10.666 |\n",
"| 2 | 3.RI.2 | Reading Informational| Key Ideas and Details| determine main idea text recount key detail explain support main idea | 10.0953 |\n",
"| 3 | K.RI.2 | Reading Informational| Key Ideas and Details| prompting support identify main topic retell key detail text | 9.8043 |\n",
"| 4 | 2.RI.6 | Reading Informational| Craft and Structure | identify main purpose text including author want answer explain describe | 9.4236 |\n",
"| 5 | 2.RI.2 | Reading Informational| Key Ideas and Details| identify main topic multiparagraph text well focus specific paragraph within text | 9.3944 |\n",
"\n",
"---\n",
"\n",
"### Top-5 Results: **SPLADE (Sparse Embedding Model)**\n",
"\n",
"| Rank | ID | Category | Sub Category | State Standard | Score |\n",
"|------|---------|----------------------|----------------------|----------------------------------------------------------------------------------|---------|\n",
"| 1 | 4.RI.2 | Reading Informational| Key Ideas and Details| determine main idea text explain supported key detail summarize text | 21.3089 |\n",
"| 2 | 3.RI.2 | Reading Informational| Key Ideas and Details| determine main idea text recount key detail explain support main idea | 20.8493 |\n",
"| 3 | 5.RI.2 | Reading Informational| Key Ideas and Details| determine two main idea text explain supported key detail summarize text | 20.2714 |\n",
"| 4 | 3.SL.2 | Speaking & Listening | Comprehension and Collaboration | determine main idea supporting detail text read aloud information presented diverse medium format including visually quantitatively orally | 17.5151 |\n",
"| 5 | 2.RI.6 | Reading Informational| Craft and Structure | identify main purpose text including author want answer explain describe | 17.512 |\n",
"\n",
"---\n",
"\n",
"### Insights:\n",
"\n",
"- Both **BM25 and SPLADE** correctly rank **\"3.RI.2\"** and **\"2.RI.6\"** in the top-5.\n",
"- **SPLADE ranks more abstract or paraphrased variants** (e.g., \"summarize\", \"supported key detail\") higher due to its semantic understanding.\n",
"- SPLADE retrieves **higher-level matches** like **\"5.RI.2\"** and **\"4.RI.2\"**, which are **semantically related** but not lexically identical.\n",
"- BM25 relies on **exact term overlap**, favoring simpler phrasings like \"identify main topic\".\n",
"\n",
"---\n",
"\n",
"### Conclusion:\n",
"\n",
"| Feature | BM25 | SPLADE |\n",
"|--------------------------|----------------------------|----------------------------------|\n",
"| Matching Type | Exact lexical match | Semantic sparse match |\n",
"| Interpretability | High (term overlap) | High (per-term weights) |\n",
"| Handles Paraphrasing | No | Yes |\n",
"| Use Case Fit | Good for short, exact queries | Great for natural language input |\n",
"\n",
"---\n",
"\n",
"### Top-1 Accuracy\n",
"\n",
"| Model | Top-1 Accuracy |\n",
"|---------|----------------|\n",
"| BM25 | **0.9959** |\n",
"| SPLADE | **0.9797** |\n",
"\n",
"---\n",
"\n",
"### Insights\n",
"\n",
"- **BM25** achieves near-perfect accuracy due to exact term matching, especially since queries are identical to indexed documents.\n",
"- **SPLADE** performs slightly lower because it may **re-rank paraphrases or semantic neighbors**, even when the original text is present.\n",
"\n",
"---\n"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "venv",
"language": "python",
"name": "venv"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.12.7"
}
},
"nbformat": 4,
"nbformat_minor": 5
}
|