Atreyu4EVR commited on
Commit
7fb4e75
·
verified ·
1 Parent(s): cb28c47

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +19 -134
README.md CHANGED
@@ -1,61 +1,12 @@
1
  ---
2
- language:
3
- - en
4
- license: other
5
  task_categories:
6
- - text-retrieval
7
  - question-answering
8
- - text-generation
9
  - text-classification
10
- - named-entity-recognition
11
- size_categories:
12
- - 1K<n<10K
13
  tags:
14
- - education
15
- - university
16
- - web-content
17
- - rag
18
- - knowledge-base
19
- - production-ready
20
- - nlp-enriched
21
- - entity-extraction
22
- - semantic
23
- pretty_name: BYU-Idaho Web Content (NLP-Enhanced)
24
- dataset_info:
25
- features:
26
- - name: index
27
- dtype: int64
28
- - name: url
29
- dtype: string
30
- - name: title
31
- dtype: string
32
- - name: topic
33
- dtype: string
34
- - name: meta_description
35
- dtype: string
36
- - name: content
37
- dtype: string
38
- - name: category
39
- dtype: string
40
- - name: content_type
41
- dtype: string
42
- - name: quality_score
43
- dtype: int64
44
- - name: reading_level
45
- dtype: float64
46
- - name: entities
47
- dtype: string
48
- - name: byui_terms
49
- dtype: string
50
- - name: acronyms
51
- dtype: string
52
- - name: key_phrases
53
- dtype: string
54
- - name: domain_ngrams
55
- dtype: string
56
- splits:
57
- - name: train
58
- num_examples: 2448
59
  ---
60
 
61
  # BYU-Idaho Web Content Dataset (NLP-Enhanced)
@@ -67,41 +18,38 @@ dataset_info:
67
  **Records:** 2,448 ultra-high-quality pages
68
  **Source:** byui.edu and subdomains
69
  **Format:** Markdown + NLP metadata (JSON fields)
70
- **Version:** 4.0.0 (NLP-Enhanced)
71
  **Quality:** 40.2% filtered + 91.5/100 avg score + Full NLP extraction
72
  **Last Updated:** December 2025
73
 
74
- ## 🚀 What's New in v4.0
75
-
76
  ### NLP Enrichment Features
77
 
78
- **Entity Extraction** (spaCy NER)
79
  - **15,289 organizations** extracted
80
  - **3,029 locations** extracted
81
  - **4,841 people** extracted
82
  - **94.2% page coverage**
83
 
84
- **Acronym Detection**
85
  - **4,036 acronyms** detected and expanded
86
  - **81.5% page coverage**
87
  - Includes common education acronyms (FAFSA, GPA, TOEFL, etc.)
88
 
89
- **Domain Terminology**
90
  - **566 BYU-Idaho specific terms** found
91
  - **16.7% page coverage**
92
  - Includes: I-Learn, Devotional, Pathway, Honor Code, campus buildings, etc.
93
 
94
- **Key Phrases**
95
  - **187 action phrases** extracted
96
  - Common educational actions: "apply for admission", "register for classes", etc.
97
 
98
- **Domain N-grams**
99
  - Common domain-specific 3-word phrases
100
  - Frequency-filtered for relevance
101
 
102
  ## Dataset Structure
103
 
104
- ### Core Fields (from v3.0)
105
 
106
  - **index** (`int64`): Sequential ID (1-2448)
107
  - **url** (`string`): Source URL
@@ -114,7 +62,7 @@ dataset_info:
114
  - **quality_score** (`int64`): Quality 0-100 (avg: 91.5)
115
  - **reading_level** (`float64`): Flesch-Kincaid grade level (avg: 14.4)
116
 
117
- ### NEW NLP Fields (v4.0)
118
 
119
  **entities** (`string` - JSON):
120
  ```json
@@ -305,21 +253,21 @@ tutoring_pages = [ds[i] for i in entity_index['Tutoring Center']]
305
 
306
  ## Use Cases
307
 
308
- ### Entity-Aware RAG
309
  ```python
310
  # Route queries based on entities mentioned
311
  if "Financial Aid" in query_entities:
312
  context = filter_to_financial_aid_entities()
313
  ```
314
 
315
- ### Acronym-Expanded Search
316
  ```python
317
  # Automatically expand acronyms in search
318
  query = expand_all_acronyms(user_query)
319
  results = semantic_search(query)
320
  ```
321
 
322
- ### Faceted Navigation
323
  ```python
324
  # Filter by entity types
325
  filters = {
@@ -329,70 +277,20 @@ filters = {
329
  }
330
  ```
331
 
332
- ### Smart Query Routing
333
  ```python
334
  # Detect BYU-Idaho terms and route to specialized retrievers
335
  if any(term in query for term in byui_terms):
336
  use_institutional_knowledge_retriever()
337
  ```
338
 
339
- ### Relationship Extraction
340
  ```python
341
  # Find connections between entities
342
  # "Which offices are in Manwaring Center?"
343
  pages_with_both = find_pages_with_entities(['Manwaring Center'], ['organizations'])
344
  ```
345
 
346
- ## Quality Metrics (Inherited from v3.0)
347
-
348
- | Metric | Value |
349
- |--------|-------|
350
- | Total pages | 2,448 |
351
- | Avg quality score | 91.5/100 |
352
- | Avg reading level | 14.4 grade |
353
- | Avg content length | 2,230 chars |
354
- | Empty titles | 0% |
355
- | Empty topics | 0% |
356
-
357
- ## Version History
358
-
359
- **v4.0.0 (NLP-Enhanced)** - December 2025
360
- - Added entity extraction (15,289 orgs, 3,029 locs, 4,841 people)
361
- - Added acronym detection (4,036 acronyms)
362
- - Added BYU-Idaho terminology (566 terms)
363
- - Added key phrase extraction (187 phrases)
364
- - Added domain n-grams
365
- - 94.2% entity coverage, 81.5% acronym coverage
366
-
367
- **v3.0.0 (Enhanced)** - December 2025
368
- - Category classification (14 categories)
369
- - Content type detection (7 types)
370
- - Quality scoring (0-100)
371
- - Reading level calculation
372
- - 2,448 pages
373
-
374
- **v2.0.0 (Production)** - December 2025
375
- - Temporal filtering
376
- - 2,666 pages
377
-
378
- **v1.0.0 (Deduplicated)** - December 2025
379
- - Basic deduplication
380
- - 3,442 pages
381
-
382
- ## Advantages Over Previous Versions
383
-
384
- | Feature | v3.0 | v4.0 (NLP) |
385
- |---------|------|-----------|
386
- | **Records** | 2,448 | 2,448 |
387
- | **Categories** | ✅ 14 | ✅ 14 |
388
- | **Quality scores** | ✅ 0-100 | ✅ 0-100 |
389
- | **Entities** | ❌ | **✅ 23,159 total** |
390
- | **Acronyms** | ❌ | **✅ 4,036** |
391
- | **Domain terms** | ❌ | **✅ 566** |
392
- | **Key phrases** | ❌ | **✅ 187** |
393
- | **Semantic search** | Limited | **✅ Advanced** |
394
- | **Entity routing** | ❌ | **✅ Yes** |
395
-
396
  ## Technical Details
397
 
398
  **NLP Pipeline:**
@@ -413,28 +311,15 @@ pages_with_both = find_pages_with_entities(['Manwaring Center'], ['organizations
413
  - Pattern: `ACRONYM (expansion)`
414
  - Pattern: `expansion (ACRONYM)`
415
 
416
- ## License
417
-
418
- Internal BYU-Idaho use. Contact: ai-team@byui.edu
419
-
420
  ## Citation
421
 
422
  ```bibtex
423
  @misc{byui-web-content-nlp-2025,
424
  title={BYU-Idaho Web Content Dataset (NLP-Enhanced)},
425
- author={BYU-Idaho AI Team},
426
  year={2025},
427
  version={4.0.0},
428
- publisher={Hugging Face},
429
  howpublished={\url{https://huggingface.co/datasets/BYU-Idaho/Web-Content}}
430
  }
431
- ```
432
-
433
- ## Contact
434
-
435
- **Email:** ai-team@byui.edu
436
- **Organization:** Brigham Young University-Idaho
437
-
438
- ---
439
-
440
- **State-of-the-Art:** This is the most feature-rich university web content dataset available, combining quality filtering, categorization, quality scoring, reading levels, AND comprehensive NLP enrichment with entity extraction, acronym detection, and domain terminology. Perfect for advanced RAG, semantic search, and intelligent educational AI applications.
 
1
  ---
2
+ license: apache-2.0
 
 
3
  task_categories:
 
4
  - question-answering
 
5
  - text-classification
6
+ language:
7
+ - en
 
8
  tags:
9
+ - agent
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
  ---
11
 
12
  # BYU-Idaho Web Content Dataset (NLP-Enhanced)
 
18
  **Records:** 2,448 ultra-high-quality pages
19
  **Source:** byui.edu and subdomains
20
  **Format:** Markdown + NLP metadata (JSON fields)
 
21
  **Quality:** 40.2% filtered + 91.5/100 avg score + Full NLP extraction
22
  **Last Updated:** December 2025
23
 
 
 
24
  ### NLP Enrichment Features
25
 
26
+ **Entity Extraction** (spaCy NER)
27
  - **15,289 organizations** extracted
28
  - **3,029 locations** extracted
29
  - **4,841 people** extracted
30
  - **94.2% page coverage**
31
 
32
+ **Acronym Detection**
33
  - **4,036 acronyms** detected and expanded
34
  - **81.5% page coverage**
35
  - Includes common education acronyms (FAFSA, GPA, TOEFL, etc.)
36
 
37
+ **Domain Terminology**
38
  - **566 BYU-Idaho specific terms** found
39
  - **16.7% page coverage**
40
  - Includes: I-Learn, Devotional, Pathway, Honor Code, campus buildings, etc.
41
 
42
+ **Key Phrases**
43
  - **187 action phrases** extracted
44
  - Common educational actions: "apply for admission", "register for classes", etc.
45
 
46
+ **Domain N-grams**
47
  - Common domain-specific 3-word phrases
48
  - Frequency-filtered for relevance
49
 
50
  ## Dataset Structure
51
 
52
+ ### Core Fields
53
 
54
  - **index** (`int64`): Sequential ID (1-2448)
55
  - **url** (`string`): Source URL
 
62
  - **quality_score** (`int64`): Quality 0-100 (avg: 91.5)
63
  - **reading_level** (`float64`): Flesch-Kincaid grade level (avg: 14.4)
64
 
65
+ ### NLP Fields
66
 
67
  **entities** (`string` - JSON):
68
  ```json
 
253
 
254
  ## Use Cases
255
 
256
+ ### Entity-Aware RAG
257
  ```python
258
  # Route queries based on entities mentioned
259
  if "Financial Aid" in query_entities:
260
  context = filter_to_financial_aid_entities()
261
  ```
262
 
263
+ ### Acronym-Expanded Search
264
  ```python
265
  # Automatically expand acronyms in search
266
  query = expand_all_acronyms(user_query)
267
  results = semantic_search(query)
268
  ```
269
 
270
+ ### Faceted Navigation
271
  ```python
272
  # Filter by entity types
273
  filters = {
 
277
  }
278
  ```
279
 
280
+ ### Smart Query Routing
281
  ```python
282
  # Detect BYU-Idaho terms and route to specialized retrievers
283
  if any(term in query for term in byui_terms):
284
  use_institutional_knowledge_retriever()
285
  ```
286
 
287
+ ### Relationship Extraction
288
  ```python
289
  # Find connections between entities
290
  # "Which offices are in Manwaring Center?"
291
  pages_with_both = find_pages_with_entities(['Manwaring Center'], ['organizations'])
292
  ```
293
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
294
  ## Technical Details
295
 
296
  **NLP Pipeline:**
 
311
  - Pattern: `ACRONYM (expansion)`
312
  - Pattern: `expansion (ACRONYM)`
313
 
 
 
 
 
314
  ## Citation
315
 
316
  ```bibtex
317
  @misc{byui-web-content-nlp-2025,
318
  title={BYU-Idaho Web Content Dataset (NLP-Enhanced)},
319
+ author={Ron Vallejo},
320
  year={2025},
321
  version={4.0.0},
322
+ publisher={Brigham Young University-Idaho},
323
  howpublished={\url{https://huggingface.co/datasets/BYU-Idaho/Web-Content}}
324
  }
325
+ ```