emolero commited on
Commit
166193c
·
verified ·
1 Parent(s): 040dd73

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

Browse files
Files changed (1) hide show
  1. README.md +9 -90
README.md CHANGED
@@ -17,96 +17,15 @@ size_categories:
17
  pretty_name: 3GPP Specifications (Rel-8 to Rel-20)
18
  ---
19
 
20
- # 3GPP Specifications — GSMA Mirror
21
 
22
- Two-folder mirror of the 3GPP Technical Specification corpus, Releases 8
23
- through 20, plus the full Datalab-converted Markdown rendering used for
24
- downstream training and retrieval.
25
 
26
- ## Layout
27
-
28
- ```
29
- GSMA/3GPP/
30
- ├── original/ raw sources, as downloaded from 3gpp.org
31
- │ └── Rel-{8..20}/
32
- │ └── {NN}_series/
33
- │ ├── *.docx
34
- │ ├── *.doc (legacy, mostly Rel-18 41-55 series)
35
- │ └── *.zip (Rel-20 paired packages)
36
- └── marked/ Datalab-converted Markdown + inline images
37
- └── Rel-{8..19}/
38
- └── {NN}_series/
39
- └── {spec_id}/
40
- ├── raw.md
41
- └── *.jpg (figures extracted alongside the text)
42
- ```
43
-
44
- `marked/` does not yet include Rel-20 (ingestion in progress).
45
-
46
- ## Coverage
47
-
48
- | Release | .docx | .doc | .zip | Total |
49
- |---------|------:|-----:|-----:|------:|
50
- | Rel-8 | 1145 | 0 | 0 | 1145 |
51
- | Rel-9 | 1254 | 0 | 0 | 1254 |
52
- | Rel-10 | 1132 | 0 | 0 | 1132 |
53
- | Rel-11 | 1265 | 0 | 0 | 1265 |
54
- | Rel-12 | 1316 | 0 | 0 | 1316 |
55
- | Rel-13 | 1429 | 0 | 0 | 1429 |
56
- | Rel-14 | 1393 | 0 | 0 | 1393 |
57
- | Rel-15 | 1605 | 0 | 0 | 1605 |
58
- | Rel-16 | 1713 | 0 | 0 | 1713 |
59
- | Rel-17 | 1906 | 0 | 0 | 1906 |
60
- | Rel-18 | 1051 | 564 | 0 | 1615 |
61
- | Rel-19 | 1542 | 75 | 0 | 1617 |
62
- | Rel-20 | 42 | 6 | 48 | 96 |
63
-
64
- Grand total: ~17,686 source files across 13 releases.
65
-
66
- Notes:
67
-
68
- - Rel-14 is the first release with `38_series` (5G NR).
69
- - Rel-19 omits `25_series` (UTRA legacy, deprecated).
70
- - Rel-18 extends past 38 into the 41–55 range (mostly legacy `.doc`).
71
- - Rel-20 mixes `.docx` specs with their paired `.zip` distributions.
72
-
73
- ## Quickstart
74
-
75
- Pull a single spec:
76
-
77
- ```bash
78
- curl -L -o 21101-j00.docx \
79
- https://huggingface.co/datasets/GSMA/3GPP/resolve/main/original/Rel-19/21_series/21101-j00.docx
80
  ```
81
-
82
- Pull the markdown view of the same spec:
83
-
84
- ```bash
85
- curl -L -o raw.md \
86
- https://huggingface.co/datasets/GSMA/3GPP/resolve/main/marked/Rel-19/21_series/21101/raw.md
87
- ```
88
-
89
- Clone a single release folder with the HF CLI:
90
-
91
- ```bash
92
- huggingface-cli download GSMA/3GPP \
93
- --repo-type dataset \
94
- --include 'marked/Rel-19/**' \
95
- --local-dir ./rel-19
96
- ```
97
-
98
- ## Provenance
99
-
100
- - `original/` was downloaded from `3gpp.org` release archives.
101
- - `marked/` is produced by running each document through
102
- [Datalab's](https://datalab.to/) DOCX → Markdown converter, preserving
103
- section structure, tables, and extracting embedded figures as JPGs.
104
-
105
- ## Licence
106
-
107
- 3GPP specifications are released under the 3GPP terms of use. Redistribution
108
- here is limited to mirroring the public publications; consult the upstream
109
- source for authoritative versions and for any commercial use.
110
-
111
- - Upstream: https://www.3gpp.org/specifications
112
- - 3GPP copyright: https://www.3gpp.org/about-us/ip-policy
 
17
  pretty_name: 3GPP Specifications (Rel-8 to Rel-20)
18
  ---
19
 
20
+ # 3GPP specification mirror
21
 
22
+ This dataset mirrors 3GPP's published specifications. Every source is kept twice: `original/` is the document as 3GPP released it, 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 3GPP release, Rel-8 through Rel-20. `MANIFEST.md` indexes the snapshot.
 
 
23
 
24
+ ```text
25
+ 3gpp/
26
+ original/ # specs as published, by release
27
+ Rel-15/ Rel-16/ Rel-17/ Rel-18/ ...
28
+ marked/ # Markdown mirror of original/, same paths
29
+ Rel-18/.../raw.md # one per document, images beside it
30
+ MANIFEST.md # snapshot index
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
31
  ```