tmforum / README.md
emolero's picture
Unify card: Open-Telco Telecom Standards Corpus
05abff2 verified
|
Raw
History Blame Contribute Delete
3.13 kB
metadata
license: other
license_name: tmforum
license_link: https://www.tmforum.org/
language:
  - en
pretty_name: TM Forum Open APIs and ODA Components
tags:
  - telecommunications
  - tmforum
  - oda
  - api
  - open-telco

TM Forum source mirror

Part of the Open-Telco Telecom Standards Corpus.
Sibling mirrors: 3GPP · ETSI · ITU-T · O-RAN · GSMA · TM Forum · CAMARA

This dataset holds TM Forum's Open API specifications and ODA component definitions, the set TM Forum publishes for open digital architecture. Every source is kept twice: original/ is the file as TM Forum released it (apis/ holds the OpenAPI and Swagger specs, components/ holds the ODA component YAML), and marked/ is that same file converted to Markdown for search and retrieval, one raw.md per file at the matching path. manifest.jsonl carries one row per file (path, SHA-256, parse status) and STATUS.md reports how much of the corpus has been parsed.

tmforum/
  original/
    apis/          # OpenAPI / Swagger specs (TMF6xx, TMF9xx)
    components/    # ODA component definitions (TMFC0xx)
  marked/          # Markdown mirror of original/, same paths
    apis/<spec>/raw.md
    components/<component>/raw.md
  manifest.jsonl   # one row per file: path, sha256, parse status
  STATUS.md        # parse-coverage summary

How it is organized

  • original/ holds the files as TM Forum published them: apis/ carries the OpenAPI and Swagger specs (TMF6xx, TMF9xx), components/ carries the ODA component YAML (TMFC0xx).
  • marked/ is the Markdown twin of original/ at identical paths, one raw.md per file.
  • manifest.jsonl carries one row per file (path, SHA-256, parse status); STATUS.md reports parse coverage.

How to use

Pull only the Markdown twins (skip the heavy original/ tree) and read them straight:

from huggingface_hub import snapshot_download

path = snapshot_download("GSMA/tmforum", repo_type="dataset", allow_patterns="marked/**")
# every parsed document is a marked/**/raw.md

The corpus

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.

License and attribution

The mirrored documents remain the property of TM Forum and stay subject to its terms; see www.tmforum.org. This dataset reproduces them in original and Markdown form for research, search, and retrieval. Cite the underlying specification by its TMF number when you use it.