PhillyMac commited on
Commit
ba5217f
·
verified ·
1 Parent(s): 0cd4e22

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +78 -45
README.md CHANGED
@@ -1,47 +1,80 @@
1
  ---
2
- dataset_info:
3
- features:
4
- - name: text
5
- dtype: string
6
- - name: source_url
7
- dtype: string
8
- - name: source_title
9
- dtype: string
10
- - name: source_domain
11
- dtype: string
12
- - name: license_type
13
- dtype: string
14
- - name: attribution_required
15
- dtype: bool
16
- - name: attribution_text
17
- dtype: string
18
- - name: license_url
19
- dtype: string
20
- - name: relevance_score
21
- dtype: float64
22
- - name: quality_score
23
- dtype: float64
24
- - name: topics
25
- dtype: string
26
- - name: character_count
27
- dtype: int64
28
- - name: subject_name
29
- dtype: string
30
- - name: subject_type
31
- dtype: string
32
- - name: extraction_date
33
- dtype: string
34
- - name: embedding
35
- list: float64
36
- splits:
37
- - name: train
38
- num_bytes: 594264
39
- num_examples: 152
40
- download_size: 519440
41
- dataset_size: 594264
42
- configs:
43
- - config_name: default
44
- data_files:
45
- - split: train
46
- path: data/train-*
47
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ license: cc0-1.0
3
+ task_categories:
4
+ - text-generation
5
+ - feature-extraction
6
+ language:
7
+ - en
8
+ tags:
9
+ - corpus
10
+ - leadership
11
+ - historical
12
+ - deku-corpus-builder
13
+ size_categories:
14
+ - 1K<n<10K
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
15
  ---
16
+
17
+ # Communication-Topic-1
18
+
19
+ This corpus was automatically generated by the **Deku Corpus Builder** for use in RAG-based AI applications.
20
+
21
+ ## Dataset Description
22
+
23
+ - **Subject**: Communication
24
+ - **Subject Type**: topic
25
+ - **Total Items**: 152
26
+ - **Items Requiring Attribution**: 0
27
+ - **Has Embeddings**: Yes (all-MiniLM-L6-v2)
28
+ - **Created**: 2026-03-17
29
+
30
+ ## Dataset Structure
31
+
32
+ Each record contains:
33
+ - `text`: The content text
34
+ - `source_url`: Original source URL
35
+ - `source_title`: Title of the source document
36
+ - `source_domain`: Domain of the source
37
+ - `license_type`: License classification (e.g. `public_domain`, `cc_by`, `cc_by_sa`)
38
+ - `attribution_required`: Boolean — True for CC BY / CC BY-SA and other attribution-required licenses
39
+ - `attribution_text`: Formatted Creative Commons attribution string (empty if not required)
40
+ - `license_url`: URL to the CC license deed (empty if not required)
41
+ - `relevance_score`: Relevance to the subject (0-1)
42
+ - `quality_score`: Content quality score (0-1)
43
+ - `topics`: JSON array of detected topics
44
+ - `character_count`: Length of the text
45
+ - `subject_name`: The subject this content relates to
46
+ - `subject_type`: "personality" or "topic"
47
+ - `extraction_date`: When the content was extracted
48
+ - `embedding`: Pre-computed 384-dimensional embedding vector
49
+
50
+ ## Attribution
51
+
52
+ 0 of 152 chunks in this corpus require attribution under their source license.
53
+ When building lessons from these chunks, the `attribution_text` field must be surfaced
54
+ in the lesson output per the Legend Leadership Attribution Tracking Spec.
55
+
56
+ ## Usage
57
+
58
+ ```python
59
+ from datasets import load_dataset
60
+
61
+ dataset = load_dataset("PhillyMac/Communication_Topic_1")
62
+
63
+ # Access attribution-required chunks
64
+ for item in dataset["train"]:
65
+ if item["attribution_required"]:
66
+ print(item["attribution_text"])
67
+ ```
68
+
69
+ ## Integration with RAG
70
+
71
+ This dataset is designed to be integrated with existing embedded corpuses. The embeddings use the `sentence-transformers/all-MiniLM-L6-v2` model, compatible with FAISS indexing.
72
+
73
+ ## License
74
+
75
+ Content is sourced from public domain and Creative Commons licensed materials.
76
+ See individual `license_type` fields for per-chunk licensing details.
77
+
78
+ ## Generated By
79
+
80
+ [Deku Corpus Builder](https://github.com/PhillyMac/deku-corpus-builder) - An automated corpus building system for AI applications.