Skip to content

Commit 47e84a3

Browse files
committed
docs(data): correct the path patterns in data/README.md
brand/ has a country folder, and soc/ and smartphone/ have a year folder; the file showed none of them and left out eight categories. It now lists every category, explains _verify/, and points at the table in the root README. The note about curation no longer says every record is hand-verified: `verified` on the record says that.
1 parent dc054d2 commit 47e84a3

1 file changed

Lines changed: 27 additions & 12 deletions

File tree

‎data/README.md‎

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,39 @@
11
# data/ — curated dataset
22

3-
These JSON files are the **curated, validated** records the API serves. Layout is
4-
singular folder names, organised by brand:
3+
These JSON files are the **curated, validated** records the API serves: one
4+
file per record, named `<slug>.json`, in singular category folders.
55

66
```
7-
brand/<slug>.json
8-
soc/<manufacturer>/<slug>.json
9-
smartphone/<brand>/<slug>.json
10-
gpu/<manufacturer>/<year>/<segment>/<slug>.json # GPUs are split by release year then segment (consumer | enterprise)
11-
cpu/<manufacturer>/<year>/<segment>/<slug>.json # CPUs split by release year then segment (consumer | enterprise)
7+
brand/<country>/<slug>.json # country code in lower case, or unknown/
8+
soc/<manufacturer>/<year>/<slug>.json
9+
cpu/<manufacturer>/<year>/<consumer|enterprise>/<slug>.json
10+
gpu/<manufacturer>/<year>/<consumer|enterprise>/<slug>.json
11+
smartphone/<brand>/<year>/<slug>.json # or <year>/<base_model>/<slug>.json
12+
tablet/<brand>/<year>/<base_model>/<slug>.json # watch/, pda/, laptop/ and monitor/ are the same
13+
device_catalog/<brand>/<slug>.json # device identities with no known release date
14+
software/<prefix>/<slug>.json # prefix = first two characters of the slug
15+
website/<prefix>/<slug>.json
16+
_verify/ # not records: see below
1217
```
1318

14-
GPU `<segment>` is:
19+
The [root README](../README.md#layout) has the same table with file counts and
20+
an example for each category.
21+
22+
The `consumer` / `enterprise` folder is a coarse split. For GPUs:
1523
* `consumer` — gaming/desktop & laptop dGPUs (GeForce GTX/RTX, Radeon RX/R9/HD, Arc, Voodoo, MTT S60/S70/S80, …)
1624
* `enterprise` — datacenter compute, AI accelerators, workstation pro cards (Tesla, A100/H100/B200, Quadro/RTX A/RTX PRO, Radeon Pro W, Instinct MI, MTT S3000/S4000, Vega Frontier, AI-focused TITAN V/RTX, …)
1725

26+
For CPUs, `enterprise` holds server and most HEDT parts. The record's own
27+
`segment` field is finer: `desktop`, `laptop`, `hedt` or `server`.
28+
29+
`_verify/` holds the verification ledger (`ledger.jsonl`), the status aggregate
30+
(`status.json`) and the caches under `state/`. TechEngine's verify tools write
31+
them; don't edit them by hand.
32+
1833
> ⚠️ **This is a curated subset — NOT an exhaustive list of every device/chip.**
19-
> It is hand-verified and intentionally partial. Breadth is expanded out-of-band
20-
> through an internal pipeline that publishes curated records here after review;
21-
> each record carries `source_urls`. Don't assume a device is missing-by-error —
22-
> it may simply not be curated yet.
34+
> It is intentionally partial. New records come from TechEngine's collectors and
35+
> land here through a reviewed PR; each record carries `source_urls`, and
36+
> `verified` says whether it has passed verification. Don't assume a device is
37+
> missing-by-error — it may simply not be curated yet.
2338
2439
Validate after edits: `python -m app.validate`. Add only real, sourced models.

0 commit comments

Comments
 (0)