Upload README.md with huggingface_hub

README.md

@@ -12,50 +12,123 @@ configs:
 - config_name: default
   data_files:
   - split: train
-    path: data/train.parquet
+    path: data/*/train.parquet
+- config_name: WG11
+  data_files:
+  - split: train
+    path: data/WG11/train.parquet
+- config_name: WG2
+  data_files:
+  - split: train
+    path: data/WG2/train.parquet
+- config_name: WG6
+  data_files:
+  - split: train
+    path: data/WG6/train.parquet
+- config_name: WG10
+  data_files:
+  - split: train
+    path: data/WG10/train.parquet
+- config_name: WG1
+  data_files:
+  - split: train
+    path: data/WG1/train.parquet
+- config_name: WG3
+  data_files:
+  - split: train
+    path: data/WG3/train.parquet
+- config_name: WG5
+  data_files:
+  - split: train
+    path: data/WG5/train.parquet
+- config_name: TIFG
+  data_files:
+  - split: train
+    path: data/TIFG/train.parquet
+- config_name: WG9
+  data_files:
+  - split: train
+    path: data/WG9/train.parquet
+- config_name: WG4
+  data_files:
+  - split: train
+    path: data/WG4/train.parquet
+- config_name: WG7
+  data_files:
+  - split: train
+    path: data/WG7/train.parquet
 ---
 
 # O-RAN Specifications Corpus
 
-Markdown-parsed corpus of o-ran specifications working-group documents (PRDs, technical reports, white papers).
-Source DOCX/PDFs were converted to markdown via the Datalab Marker API (`mode=accurate`).
+Technical Specifications (TS) and Technical Reports (TR) from the O-RAN Alliance working groups (Release R005).
+
+Source documents (DOCX, PDF) were converted to GitHub-flavoured Markdown via the
+[Datalab Marker](https://www.datalab.to) API (`mode=accurate`) on 2026-05-14.
+Only the parsed `.md` text is published here — original binaries and extracted images are not redistributed.
 
 ## Stats
 
 - **Documents**: 66
-- **Characters (total)**: 25,581,453
-- **Images extracted**: 7,408
-
-| Working group | Docs |
-|---|---:|
-| WG11 | 12 |
-| WG2 | 12 |
-| WG6 | 8 |
-| WG10 | 7 |
-| WG1 | 6 |
-| WG3 | 6 |
-| WG5 | 5 |
-| TIFG | 4 |
-| WG9 | 3 |
-| WG4 | 2 |
-| WG7 | 1 |
-
-## Fields
+- **Working groups**: 11
+- **Total characters**: 25,581,453
+- **Total words**: 2,681,736
+
+## Working groups
+
+Each row below corresponds to a `config_name` in the dataset viewer — pick one to browse only that
+working group, or pick `default` to see every document.
+
+| WG | Docs | Description |
+|---|---:|---|
+| `WG11` | 12 | Security — threat modeling, zero-trust, post-quantum, certificate management |
+| `WG2` | 12 | Non-RT RIC & A1 / R1 Interfaces — non-real-time intelligent controller |
+| `WG6` | 8 | Cloudification & Orchestration — O-Cloud, OAM, deployment |
+| `WG10` | 7 | OAM and SMO — Service Management & Orchestration, O1 interface, information models |
+| `WG1` | 6 | Use Cases & Overall Architecture — RAN architecture, NTN, CCIN use cases |
+| `WG3` | 6 | Near-RT RIC & E2 / Y1 Interfaces — near-real-time intelligent controller, xApps |
+| `WG5` | 5 | Open F1 / W1 / E1 / X2 / Xn Interfaces — midhaul and CU-DU split |
+| `TIFG` | 4 | Test & Integration Focus Group — certification badge, E2E test specifications |
+| `WG9` | 3 | Open X-Haul Transport — fronthaul/midhaul/backhaul transport, XPSAAS |
+| `WG4` | 2 | Open Fronthaul Interfaces — CUS-plane, M-plane, IOT, MP-YANG |
+| `WG7` | 1 | White-Box Hardware — open hardware reference designs |
+
+## Schema
 
 | Column | Type | Description |
 |---|---|---|
-| `wg` | string | Working group (e.g. `FASG`, `eSim`, `NG` for GSMA; `WG1`, `WG10`, `TIFG` for O-RAN) |
+| `wg` | string | Working group code (matches the config name) |
 | `doc_id` | string | Document filename stem |
-| `rel_path` | string | Path relative to corpus root |
-| `text` | string | Markdown body |
-| `n_chars` | int | Length of `text` |
-| `n_images` | int | Number of image files referenced |
-| `images` | list[string] | Image filenames (in `files/<rel_path>/images/`) |
+| `title` | string | First H1 in the markdown, or `doc_id` when absent |
+| `rel_path` | string | Path relative to the corpus root |
+| `text` | string | Parsed markdown body |
+| `n_chars` | int64 | `len(text)` |
+| `n_words` | int64 | Whitespace word count of `text` |
+| `n_lines` | int64 | Line count of `text` |
+
+## Loading
+
+```python
+from datasets import load_dataset
+
+# Every document across every working group
+ds = load_dataset("GSMA/oran", "default", split="train")
+
+# Just one working group (e.g. WG11)
+ds_wg = load_dataset("GSMA/oran", "WG11", split="train")
+
+print(ds_wg[0]["title"])
+print(ds_wg[0]["text"][:500])
+```
 
 ## Layout
 
 ```
-data/train.parquet                       row-oriented dataset
-files/<wg>/<doc-stem>/doc.md             original markdown
-files/<wg>/<doc-stem>/images/*.png|jpg   inline images referenced from doc.md
+data/<wg>/train.parquet     one parquet shard per working group
+README.md                   this dataset card
 ```
+
+## License and use
+
+Private dataset; access restricted to GSMA organisation members on HuggingFace. The underlying
+documents are subject to GSMA / O-RAN Alliance redistribution terms — internal research use only.