emolero commited on
Commit
474180d
·
verified ·
1 Parent(s): 71af7ca

docs: short README (structure overview + file-map)

Browse files
Files changed (1) hide show
  1. README.md +12 -72
README.md CHANGED
@@ -59,76 +59,16 @@ configs:
59
  path: data/WG7/train.parquet
60
  ---
61
 
62
- # O-RAN Specifications Corpus
63
-
64
- Technical Specifications (TS) and Technical Reports (TR) from the O-RAN Alliance working groups (Release R005).
65
-
66
- Source documents (DOCX, PDF) were converted to GitHub-flavoured Markdown via the
67
- [Datalab Marker](https://www.datalab.to) API (`mode=accurate`) on 2026-05-14.
68
- Only the parsed `.md` text is published here original binaries and extracted images are not redistributed.
69
-
70
- ## Stats
71
-
72
- - **Documents**: 66
73
- - **Working groups**: 11
74
- - **Total characters**: 25,581,453
75
- - **Total words**: 2,681,736
76
-
77
- ## Working groups
78
-
79
- Each row below corresponds to a `config_name` in the dataset viewer — pick one to browse only that
80
- working group, or pick `default` to see every document.
81
-
82
- | WG | Docs | Description |
83
- |---|---:|---|
84
- | `WG11` | 12 | Security — threat modeling, zero-trust, post-quantum, certificate management |
85
- | `WG2` | 12 | Non-RT RIC & A1 / R1 Interfaces — non-real-time intelligent controller |
86
- | `WG6` | 8 | Cloudification & Orchestration — O-Cloud, OAM, deployment |
87
- | `WG10` | 7 | OAM and SMO — Service Management & Orchestration, O1 interface, information models |
88
- | `WG1` | 6 | Use Cases & Overall Architecture — RAN architecture, NTN, CCIN use cases |
89
- | `WG3` | 6 | Near-RT RIC & E2 / Y1 Interfaces — near-real-time intelligent controller, xApps |
90
- | `WG5` | 5 | Open F1 / W1 / E1 / X2 / Xn Interfaces — midhaul and CU-DU split |
91
- | `TIFG` | 4 | Test & Integration Focus Group — certification badge, E2E test specifications |
92
- | `WG9` | 3 | Open X-Haul Transport — fronthaul/midhaul/backhaul transport, XPSAAS |
93
- | `WG4` | 2 | Open Fronthaul Interfaces — CUS-plane, M-plane, IOT, MP-YANG |
94
- | `WG7` | 1 | White-Box Hardware — open hardware reference designs |
95
-
96
- ## Schema
97
-
98
- | Column | Type | Description |
99
- |---|---|---|
100
- | `wg` | string | Working group code (matches the config name) |
101
- | `doc_id` | string | Document filename stem |
102
- | `title` | string | First H1 in the markdown, or `doc_id` when absent |
103
- | `rel_path` | string | Path relative to the corpus root |
104
- | `text` | string | Parsed markdown body |
105
- | `n_chars` | int64 | `len(text)` |
106
- | `n_words` | int64 | Whitespace word count of `text` |
107
- | `n_lines` | int64 | Line count of `text` |
108
-
109
- ## Loading
110
-
111
- ```python
112
- from datasets import load_dataset
113
-
114
- # Every document across every working group
115
- ds = load_dataset("GSMA/oran", "default", split="train")
116
-
117
- # Just one working group (e.g. WG11)
118
- ds_wg = load_dataset("GSMA/oran", "WG11", split="train")
119
-
120
- print(ds_wg[0]["title"])
121
- print(ds_wg[0]["text"][:500])
122
- ```
123
-
124
- ## Layout
125
-
126
- ```
127
- data/<wg>/train.parquet one parquet shard per working group
128
- README.md this dataset card
129
  ```
130
-
131
- ## License and use
132
-
133
- Private dataset; access restricted to GSMA organisation members on HuggingFace. The underlying
134
- documents are subject to GSMA / O-RAN Alliance redistribution terms — internal research use only.
 
59
  path: data/WG7/train.parquet
60
  ---
61
 
62
+ # O-RAN source mirror
63
+
64
+ This dataset mirrors the O-RAN ALLIANCE's published specifications and technical reports. Every source is kept twice: `original/` is the document as O-RAN released it (PDF and Word), and `marked/` is that same document converted to Markdown for search and retrieval, one `raw.md` per document with any figures extracted beside it. The two trees share identical paths, so a file in `original/` has a parsed twin at the matching path under `marked/`; both are grouped by O-RAN ALLIANCE working group (WG1 through WG11, plus the focus groups SFG, SuFG, and TIFG). `manifest.jsonl` carries one row per file (path, SHA-256, parse status), and `STATUS.md` reports how much of the corpus has been parsed.
65
+
66
+ ```text
67
+ oran/
68
+ original/ # specs as published, by working group
69
+ WG1/ WG2/ WG4/ TIFG/ ...
70
+ marked/ # Markdown mirror of original/, same paths
71
+ WG4/.../raw.md # one per document, images beside it
72
+ manifest.jsonl # one row per file: path, sha256, parse status
73
+ STATUS.md # parse-coverage summary
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
74
  ```