Sophymarine-admin commited on
Commit
855a406
·
verified ·
1 Parent(s): e322135

docs: dataset card

Browse files
Files changed (1) hide show
  1. README.md +148 -0
README.md CHANGED
@@ -108,6 +108,35 @@ the events first-class observables**:
108
  Every row carries `_retrieved_at` (ISO 8601 timestamp). Group / join
109
  across snapshot dates to build per-company state timelines.
110
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
111
  ## How to load
112
 
113
  The dataset ships with one configuration per jurisdiction plus an
@@ -323,6 +352,125 @@ as nested JSON instead of a stringified JSON column.
323
  event-detection models become meaningful; expect 26+ snapshots
324
  (~6 months) before survival analysis on dissolution becomes robust.
325
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
326
  ## File layout
327
 
328
  ```
 
108
  Every row carries `_retrieved_at` (ISO 8601 timestamp). Group / join
109
  across snapshot dates to build per-company state timelines.
110
 
111
+ ## When to use this dataset vs the live OpenRegistry MCP server
112
+
113
+ The dataset and the MCP server are complementary, not redundant.
114
+
115
+ ### Use this **dataset** for
116
+
117
+ | Use case | Why dataset, not MCP |
118
+ |----------|---------------------|
119
+ | **Reproducible evals** | Frozen point-in-time data → the same eval gives the same scores week over week. MCP returns live data and would drift. |
120
+ | **Fine-tuning** | Deterministic, version-pinned training corpus. MCP is an inference endpoint, not a training source. |
121
+ | **Historical / longitudinal analysis** | Every row carries `_retrieved_at`. MCP only knows "now". |
122
+ | **Panel-data research** | Build per-company state timelines across weekly snapshots. Impossible via MCP. |
123
+ | **Offline / air-gapped environments** | No outbound network required. |
124
+ | **Diff past state vs current state** | Compare a snapshot row to an MCP call to detect change. |
125
+
126
+ ### Use the **live MCP server** (`openregistry.sophymarine.com`) for
127
+
128
+ | Use case | Why MCP, not dataset |
129
+ |----------|---------------------|
130
+ | **Real-time status** | Companies dissolve daily; the dataset is stale by definition. |
131
+ | **Officers / directors / PSC** | Not in this dataset (profile-layer only). |
132
+ | **Shareholders / financials** | Not in this dataset. |
133
+ | **Filings list and document downloads** | MCP fetches the actual filing (PDF, iXBRL, etc.). |
134
+ | **Production agent serving live customer queries** | Agents need current data. |
135
+ | **Free-text search across registries** | MCP accepts arbitrary name queries; the dataset is a fixed alphabet-seeded sample. |
136
+
137
+ **Rule of thumb**: training / evaluation / research → **dataset**.
138
+ Production inference → **MCP**.
139
+
140
  ## How to load
141
 
142
  The dataset ships with one configuration per jurisdiction plus an
 
352
  event-detection models become meaningful; expect 26+ snapshots
353
  (~6 months) before survival analysis on dissolution becomes robust.
354
 
355
+ ## Decontamination
356
+
357
+ This dataset is a **structured registry corpus** — every row is factual
358
+ fields (company name, registration number, status, dates, addresses).
359
+ Its content shape is fundamentally different from the text-heavy
360
+ benchmarks that LLM evaluations use, so contamination risk is low by
361
+ construction. We have specifically verified non-overlap with:
362
+
363
+ - **MMLU / MMLU-Pro**: multi-domain academic QA. None of the question
364
+ banks reference specific company-registry records.
365
+ - **HumanEval / MBPP**: code generation. No overlap with structured
366
+ registry data.
367
+ - **GSM8K / MATH**: arithmetic word problems. No overlap.
368
+ - **BBH (Big-Bench Hard)**: reasoning tasks. No registry-style content.
369
+ - **ARC / HellaSwag / TruthfulQA**: commonsense + factual QA. No
370
+ company-registration items.
371
+ - **GPQA / DROP / AGIEval**: domain-specialized QA. No overlap.
372
+
373
+ The `traces/` subset is **fully synthetic** in its natural-language
374
+ wording (templated from row data, not drawn from any external corpus).
375
+ Tool-call arguments and tool results are deterministically derived from
376
+ the snapshot rows, so the traces themselves cannot have been seen by
377
+ any prior model.
378
+
379
+ If you discover overlap with a benchmark we haven't listed, please open
380
+ an issue at
381
+ https://huggingface.co/datasets/Sophymarine/openregistry-snapshots/discussions.
382
+
383
+ ## PII considerations
384
+
385
+ Every row in this dataset comes verbatim from the official national
386
+ company register of its jurisdiction. **All of it is already public** —
387
+ each of these registers is, by statute, a public-record system where
388
+ companies are required to publish basic information. None of the data
389
+ was obtained through scraping protected pages, leaked sources, or
390
+ non-public channels.
391
+
392
+ That said, registry rules differ across jurisdictions, and in some
393
+ cases a `registered_address` value is the home address of a sole
394
+ trader or single-shareholder small business:
395
+
396
+ | Jurisdiction | Where home addresses can appear |
397
+ |--------------|--------------------------------|
398
+ | **AU** ABR | An ABN registered as a sole trader (Individual / Trust) typically lists the trader's residential address. |
399
+ | **IE** CRO | Sole-trader and certain non-LTD records may carry the proprietor's home address. |
400
+ | **NO** Brreg | A single-person ENK (`enkeltpersonforetak`) commonly uses the proprietor's home as `forretningsadresse`. |
401
+ | **CZ** ARES | OSVČ / živnostník (sole-trader) records may use a residential address. |
402
+ | **NZ** Companies Office | Individual sole-trader registrations follow the same pattern. |
403
+ | **FR** RNE | SARL unipersonnelle / entreprise individuelle (EI) may use a domicile address. |
404
+
405
+ This is not a legal exposure — the data is published by the registries
406
+ themselves, often as a deliberate transparency measure. But responsible
407
+ downstream use, especially in customer-facing models, means treating it
408
+ with the same care you would treat any business-personal information.
409
+
410
+ ### Filtering to commercial-only entities
411
+
412
+ If your use case requires excluding likely-residential addresses, filter
413
+ by entity type via `status_detail` or the `jurisdiction_data` JSON:
414
+
415
+ ```python
416
+ import polars as pl, json
417
+ df = pl.read_parquet(
418
+ "hf://datasets/Sophymarine/openregistry-snapshots/data/no.parquet"
419
+ )
420
+ # Drop single-person sole proprietorships in Norway
421
+ df = df.filter(
422
+ ~pl.col("jurisdiction_data").str.contains(
423
+ '"organisasjonsform":{"kode":"ENK"'
424
+ )
425
+ )
426
+ ```
427
+
428
+ Similar filters exist per jurisdiction; the `organisasjonsform` /
429
+ `comp_type_desc` / `EntityTypeCode` keys in `jurisdiction_data` carry
430
+ the entity-type code natively.
431
+
432
+ ### What this dataset does NOT include
433
+
434
+ - ❌ Director / officer / PSC personal data (DOB, full address, etc.)
435
+ - ❌ Beneficial-owner data
436
+ - ❌ Filing documents (PDFs, financial statements, deeds)
437
+ - ❌ Email addresses, phone numbers, or other contact PII beyond what
438
+ the registry publishes as part of the company record
439
+
440
+ If a row's `jurisdiction_data` contains an `email` or `telefon` field,
441
+ it is because the company chose to publish that contact at the
442
+ registry — it is not personal data scraped from elsewhere.
443
+
444
+ ## Integrity & provenance (SHA-256 manifest)
445
+
446
+ Every Parquet file in this dataset is hashed and listed in
447
+ `MANIFEST.sha256` at the repo root. This lets downstream consumers
448
+ verify byte-for-byte that the file they downloaded matches the snapshot
449
+ we published:
450
+
451
+ ```bash
452
+ # Linux / Mac / Git Bash
453
+ huggingface-cli download Sophymarine/openregistry-snapshots --repo-type dataset --local-dir /tmp/orgs
454
+ cd /tmp/orgs && sha256sum -c MANIFEST.sha256
455
+ ```
456
+
457
+ ```powershell
458
+ # PowerShell
459
+ $exp = Get-Content MANIFEST.sha256 | ForEach-Object {
460
+ $h, $f = $_ -split '\s+', 2
461
+ [pscustomobject]@{ Expected = $h.ToLower(); File = $f.Trim() }
462
+ }
463
+ $exp | ForEach-Object {
464
+ $got = (Get-FileHash $_.File -Algorithm SHA256).Hash.ToLower()
465
+ if ($got -ne $_.Expected) { Write-Error "MISMATCH: $($_.File)" }
466
+ else { Write-Output "OK: $($_.File)" }
467
+ }
468
+ ```
469
+
470
+ A mismatch means either local corruption or that someone is serving you
471
+ a tampered file. The manifest is signed by the same commit that ships
472
+ the data files, so the integrity check covers the full snapshot.
473
+
474
  ## File layout
475
 
476
  ```