meruem123 commited on
Commit
046c412
Β·
verified Β·
1 Parent(s): 34a1c85

Delete Readme.md

Browse files
Files changed (1) hide show
  1. Readme.md +0 -52
Readme.md DELETED
@@ -1,52 +0,0 @@
1
- # πŸ“š CCSS Alignment with BM25 & SPLADE
2
-
3
- This project allows you to align input educational text (lesson plans, learning objectives) with Common Core State Standards (ELA) using two retrieval techniques:
4
-
5
- - **BM25** (sparse lexical search)
6
- - **SPLADE** (sparse transformer embeddings)
7
-
8
- ## πŸš€ How to Run the App
9
-
10
- Make sure you're in the project root folder, then run:
11
-
12
- ```bash
13
- streamlit run app.py
14
- ```
15
-
16
- You will be able to:
17
- - Select either BM25 or SPLADE
18
- - Input a query (e.g., "identify key ideas and details")
19
- - View top-matching CCSS standards
20
- - Compare accuracy between both retrieval models
21
-
22
- ## πŸ§ͺ Sample Starter Code for app.py
23
-
24
- ```python
25
- import streamlit as st
26
- from core.bm25_utility import bm25_utility
27
- from core.splade_utility import SpladeUtility
28
-
29
- query = st.text_input("Enter your query:")
30
- method = st.selectbox("Choose retrieval method", ["BM25", "SPLADE"])
31
-
32
- if st.button("Get Standards"):
33
- if method == "BM25":
34
- results = bm25_utility(query).retrieve_top_n_bm25()
35
- else:
36
- results = SpladeUtility(query).retrieve_top_n_splade()
37
-
38
- for r in results:
39
- st.write(f"**{r['ID']}** - {r['standard']} (Score: {r['score']})")
40
- ```
41
-
42
-
43
- ## πŸ“ Notes
44
-
45
- - Ensure that model weights for SPLADE are downloaded or cached.
46
- - Make sure you're using cleaned and preprocessed CCSS data for accurate matching.
47
- - Streamlit interface supports rapid switching between BM25 and SPLADE for testing.
48
-
49
- ---
50
-
51
- **Author**: Shivendra Gupta
52
- **Purpose**: Educational NLP for aligning teaching content to learning standards.