emolero commited on
Commit
084d6c0
·
verified ·
1 Parent(s): 78f775e

Unify card: Open-Telco Telecom Standards Corpus

Browse files
Files changed (1) hide show
  1. README.md +33 -1
README.md CHANGED
@@ -1,15 +1,22 @@
1
  ---
2
  license: other
 
 
3
  language:
4
  - en
 
5
  tags:
 
6
  - camara
7
- - telecom
8
  - api
 
9
  ---
10
 
11
  # CAMARA source mirror
12
 
 
 
 
13
  This dataset mirrors the CAMARA project's network APIs. Every source is kept twice: `original/` is the API definition as CAMARA published it (OpenAPI YAML and supporting docs), and `marked/` is that same file converted to Markdown for search and retrieval, one `raw.md` per document. 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 CAMARA API family, one folder per API (such as ConsentManagement and CarrierBillingCheckOut). `manifest.jsonl` carries one row per file (path, SHA-256, parse status), and `STATUS.md` reports how much of the corpus has been parsed.
14
 
15
  ```text
@@ -21,3 +28,28 @@ camara/
21
  manifest.jsonl # one row per file: path, sha256, parse status
22
  STATUS.md # parse-coverage summary
23
  ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: other
3
+ license_name: camara
4
+ license_link: https://camaraproject.org/
5
  language:
6
  - en
7
+ pretty_name: CAMARA Network APIs
8
  tags:
9
+ - telecommunications
10
  - camara
 
11
  - api
12
+ - open-telco
13
  ---
14
 
15
  # CAMARA source mirror
16
 
17
+ > Part of the **[Open-Telco Telecom Standards Corpus](https://huggingface.co/collections/GSMA/telecom-standards-corpus-6a432dc598fc32729754fecf)**.
18
+ > Sibling mirrors: [3GPP](https://huggingface.co/datasets/GSMA/3GPP) · [ETSI](https://huggingface.co/datasets/GSMA/etsi) · [ITU-T](https://huggingface.co/datasets/GSMA/itu) · [O-RAN](https://huggingface.co/datasets/GSMA/oran) · [GSMA](https://huggingface.co/datasets/GSMA/gsma) · [TM Forum](https://huggingface.co/datasets/GSMA/tmforum) · **CAMARA**
19
+
20
  This dataset mirrors the CAMARA project's network APIs. Every source is kept twice: `original/` is the API definition as CAMARA published it (OpenAPI YAML and supporting docs), and `marked/` is that same file converted to Markdown for search and retrieval, one `raw.md` per document. 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 CAMARA API family, one folder per API (such as ConsentManagement and CarrierBillingCheckOut). `manifest.jsonl` carries one row per file (path, SHA-256, parse status), and `STATUS.md` reports how much of the corpus has been parsed.
21
 
22
  ```text
 
28
  manifest.jsonl # one row per file: path, sha256, parse status
29
  STATUS.md # parse-coverage summary
30
  ```
31
+
32
+ ## How it is organized
33
+
34
+ - `original/` holds the API definitions as CAMARA published them (OpenAPI YAML and supporting docs), grouped by API family (one folder per API, such as ConsentManagement and ConnectivityInsights).
35
+ - `marked/` is the Markdown twin of `original/` at identical paths, one `raw.md` per document.
36
+ - `manifest.jsonl` carries one row per file (path, SHA-256, parse status); `STATUS.md` reports parse coverage.
37
+
38
+ ## How to use
39
+
40
+ Pull only the Markdown twins (skip the heavy `original/` tree) and read them straight:
41
+
42
+ ```python
43
+ from huggingface_hub import snapshot_download
44
+
45
+ path = snapshot_download("GSMA/camara", repo_type="dataset", allow_patterns="marked/**")
46
+ # every parsed document is a marked/**/raw.md
47
+ ```
48
+
49
+ ## The corpus
50
+
51
+ This dataset is part of the **Open-Telco Telecom Standards Corpus**, an effort to make telecommunications open by mirroring every major standards body into clean, machine-readable Markdown. The full set: 3GPP, ETSI, ITU-T, O-RAN, GSMA, TM Forum, and CAMARA. Browse them all in the [collection](https://huggingface.co/collections/GSMA/telecom-standards-corpus-6a432dc598fc32729754fecf).
52
+
53
+ ## License and attribution
54
+
55
+ The mirrored documents remain the property of the CAMARA Project and stay subject to its terms; see [camaraproject.org](https://camaraproject.org/). This dataset reproduces them in original and Markdown form for research, search, and retrieval. Cite the underlying API definition by its CAMARA name when you use it.