Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cookbook/ai-ready-dissemination/understand.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ only the values file sees the flags without them.
## Resources

- [SDMX Content-Oriented Guidelines](https://sdmx.org/?page_id=4345): cross-domain concepts and code lists to reuse.
- [DDI Codebook 2.5](https://ddialliance.org/Specification/DDI-Codebook/2.5/) and [DDI Lifecycle 3.3](https://ddialliance.org/Specification/DDI-Lifecycle/3.3/): variable-level documentation and reusable questions and concepts; the [microdata cookbook](/cookbook/microdata-documentation/) applies them.
- [DDI Codebook 2.5](https://ddialliance.org/Specification/DDI-Codebook/2.5/) and [DDI Lifecycle 3.3](https://ddialliance.org/Specification/DDI-Lifecycle/3.3/): variable-level documentation and reusable questions and concepts; the microdata cookbook applies them.
- [UN classifications registry](https://unstats.un.org/unsd/classifications/): ISIC, CPC, COICOP, and correspondence tables; [ISCED](https://uis.unesco.org/en/topic/international-standard-classification-education-isced) and [ISCO](https://www.ilo.org/public/english/bureau/stat/isco/).
- [SKOS](https://www.w3.org/TR/skos-reference/), [XKOS](https://ddialliance.org/xkos), and [GSIM](https://unece.org/statistics/modernstats/gsim): concept schemes, classifications, and the names of statistical information objects.
- [SDMX `OBS_STATUS` code list](https://sdmx.org/?page_id=3215): the status codes for breaks, revisions, and estimates in recipe 3.3.
Expand Down
2 changes: 1 addition & 1 deletion cookbook/evaluation-suites/retrieval.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ puts them in.

- The [PI-FT toolkit](/pift-toolkit/pipeline) reports Recall@k, MRR, and nDCG@k and compares embedding models on the same queries; its [method page](/pift-toolkit/method) describes graded evaluation.
- [Data Discoverability](/docs/data-discoverability/) evaluates search by meaning over structured records with multilingual queries.
- The [microdata cookbook](/cookbook/microdata-documentation/navigate) applies the same measures to variable-level search.
- The microdata cookbook applies the same measures to variable-level search.

## Resources

Expand Down
6 changes: 3 additions & 3 deletions cookbook/language-models-in-production/design.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ the model judges each one.
a different concept. Ask for a confidence and a reason.
3. The methodologist confirms or rejects each proposal. A confirmed
match links the new variable to the concept
([microdata cookbook, chapter 4](/cookbook/microdata-documentation/concepts))
(concepts chapter of the microdata cookbook)
and inherits its definition.
4. Track the share of proposals confirmed at each level of confidence.
Stop showing proposals below the level at which few are confirmed.
Expand All @@ -143,7 +143,7 @@ definition, and the comparability note records the added category.
**What this does not do.** A match says that two questions measure the
same concept. It does not make their data comparable; that depends on
the survey mode, the population, and the categories
([microdata cookbook, chapter 6](/cookbook/microdata-documentation/rounds)).
(comparability chapter of the microdata cookbook).

</Recipe>

Expand Down Expand Up @@ -208,7 +208,7 @@ No draft is published without review.
- [Cross-Cultural Survey Guidelines](https://ccsg.isr.umich.edu/): questionnaire design, translation, and testing practice the checklist draws on.
- [DDI Lifecycle 3.3](https://ddialliance.org/Specification/DDI-Lifecycle/3.3/): reusable questions and concepts, the form of a question bank.
- [Drafting](/cookbook/metadata-curation-with-llms/draft) and [translation](/cookbook/metadata-curation-with-llms/translate) chapters of the curation cookbook: the workflows and checks for recipe 2.3.
- [Concepts chapter of the microdata cookbook](/cookbook/microdata-documentation/concepts): linking variables to concepts and classifications.
- Concepts chapter of the microdata cookbook: linking variables to concepts and classifications.

## Common mistakes

Expand Down
2 changes: 1 addition & 1 deletion cookbook/metadata-curation-with-llms/standardize.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ filter for every user.
- **Vocabulary format:** SKOS for concepts and labels, XKOS for classifications; a CSV with preferred label, URI, and alternates as the working form.
- **Mapping:** exact and fuzzy string matching (this chapter); embeddings for semantic matching; a model for proposals with a confidence.
- **Storage:** `keywords` and `topics` with vocabulary and URI in the World Bank schemas; the Metadata Editor's controlled lists.
- **International vocabularies:** the SDG indicator framework, the classifications of [chapter 4 of the microdata cookbook](/cookbook/microdata-documentation/concepts), and thematic thesauri, as sources of URIs.
- **International vocabularies:** the SDG indicator framework, the classifications of the concepts chapter of the microdata cookbook, and thematic thesauri, as sources of URIs.

## World Bank examples

Expand Down
6 changes: 3 additions & 3 deletions cookbook/ml-ready-datasets/license.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ treatment of the source records is stated in the card.

1. Establish the source. A dataset built from a public use file
inherits its disclosure control
([microdata cookbook, chapter 8](/cookbook/microdata-documentation/access)).
(access chapter of the microdata cookbook).
A dataset built from the full file is a new product and gets a new
review, with the key variables, the uniqueness measures, and the
recoding the unit requires.
Expand Down Expand Up @@ -202,15 +202,15 @@ text is reviewed again when a new version adds records.
## World Bank examples

- The World Bank's [terms of use for datasets](https://www.worldbank.org/en/about/legal/terms-of-use-for-datasets) default to CC BY 4.0, with the licence in the schema's `license` field and on every page.
- The [microdata cookbook's access chapter](/cookbook/microdata-documentation/access) gives the tiers, the disclosure control workflow, and the rules for automated and AI clients that a training dataset inherits.
- The microdata cookbook's access chapter gives the tiers, the disclosure control workflow, and the rules for automated and AI clients that a training dataset inherits.

## Resources

- [Creative Commons Attribution 4.0](https://creativecommons.org/licenses/by/4.0/): the licence text and its machine-readable URL.
- [Understanding CC licenses and generative AI](https://creativecommons.org/2023/08/18/understanding-cc-licenses-and-generative-ai/) (Creative Commons, 2023): what the licences do and do not say about training.
- [Responsible AI Licenses](https://www.licenses.ai/): the RAIL family, for comparison when the organization considers use restrictions.
- [sdcMicro practice guide](https://sdcpractice.readthedocs.io/): the disclosure control workflow the unit applies to a new product.
- [Microdata cookbook, chapter 8](/cookbook/microdata-documentation/access): the access policy with tiers and the rules for AI clients.
- Access chapter of the microdata cookbook: the access policy with tiers and the rules for AI clients.

## Common mistakes

Expand Down
4 changes: 2 additions & 2 deletions cookbook/ml-ready-datasets/shape.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ predicts without asking anyone.
say how the dataset was made or what it covers, which is the card of
[chapter 4](./document.mdx), and it does not check the data against
the description, which the
[microdata cookbook's dictionary check](/cookbook/microdata-documentation/variables)
microdata cookbook's dictionary check
does.

</Recipe>
Expand Down Expand Up @@ -225,7 +225,7 @@ as released.
- [Apache Parquet](https://parquet.apache.org/): the columnar file format for large tabular datasets.
- [Data Package standard](https://datapackage.org/): a container format for a dataset's files with a table schema per resource, and the `frictionless` tools that validate it.
- [Tidy data layout in the dissemination cookbook](/cookbook/ai-ready-dissemination/retrieve): one row per observation, codes in the file, labels in the code lists.
- [Dictionary check of the microdata cookbook](/cookbook/microdata-documentation/variables): the check that a dictionary is complete and consistent.
- Dictionary check of the microdata cookbook: the check that a dictionary is complete and consistent.

## Common mistakes

Expand Down
2 changes: 1 addition & 1 deletion cookbook/ml-ready-datasets/version.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ terms ask for citation and the card makes it easy.
- [DataCite metadata schema](https://schema.datacite.org/): the fields for a dataset version's DOI, including the relation to other versions.
- [Monitoring cookbook, chapter 3](/cookbook/monitoring-data-use/citations): collecting and merging citation events for a DOI.
- [Hugging Face dataset cards](https://huggingface.co/docs/hub/datasets-cards): where a dataset's card links a paper, and where model cards name the datasets a model was trained on.
- [Microdata cookbook, chapter 7](/cookbook/microdata-documentation/fitness): versioning each release and publishing errata, the same practice for microdata.
- Fitness chapter of the microdata cookbook: versioning each release and publishing errata, the same practice for microdata.

## Common mistakes

Expand Down
4 changes: 2 additions & 2 deletions cookbook/monitoring-data-use/act.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ them.
status: the completeness check of the
[dissemination cookbook](/cookbook/ai-ready-dissemination/find) and,
for surveys, the dictionary check of the
[microdata cookbook](/cookbook/microdata-documentation/variables).
microdata cookbook.
2. Order the work: datasets used most and documented least first. Among
them, those used outside research first, since policy and media
users read the record and nothing else.
Expand Down Expand Up @@ -183,7 +183,7 @@ matches only; "contains" and fuzzy matches wait for review.
- [Proof-Carrying Numbers](https://arxiv.org/abs/2509.06902): the program's method for checking a quoted figure against its source, applied to misquotes.
- [NADA](https://nada.ihsn.org/): the catalog's citations feature, where "used in" lists are published per study.
- [World Bank metadata schemas](https://github.com/worldbank/metadata-schemas): `data_sources` in document records and `aliases` in series records, the fields that close the loop.
- [Findability chapter of the dissemination cookbook](/cookbook/ai-ready-dissemination/find) and [chapter 3 of the microdata cookbook](/cookbook/microdata-documentation/variables): the completeness and dictionary checks that use counts prioritize.
- [Findability chapter of the dissemination cookbook](/cookbook/ai-ready-dissemination/find) and the dictionary chapter of the microdata cookbook: the completeness and dictionary checks that use counts prioritize.
- [Evaluation chapter of the dissemination cookbook](/cookbook/ai-ready-dissemination/evaluate): the question sets that misquoted figures feed.

## Common mistakes
Expand Down
2 changes: 1 addition & 1 deletion cookbook/serving-statistics-to-agents/access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ missing scope. The public series need no token at all.
**What this does not do.** Authorization identifies users and their scopes.
It does not decide whether a licensed product may be served to an agent at
all. That decision belongs to the access policy of the
[microdata cookbook](/cookbook/microdata-documentation/access).
microdata cookbook.

</Recipe>

Expand Down
2 changes: 1 addition & 1 deletion cookbook/serving-statistics-to-agents/purpose.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ should have stayed behind a licence.
scope at launch. Microdata are a special case: the interface may serve
their metadata, so that an assistant can tell a user that a survey
exists and how to apply for it, but it never serves the data
([chapter 8 of the microdata cookbook](/cookbook/microdata-documentation/access)).
(the access chapter of the microdata cookbook).
3. State what the interface does not do. It does not estimate, forecast,
or combine series into new figures. The assistant reports what the
organization publishes, and the statement says so in those words.
Expand Down
2 changes: 1 addition & 1 deletion cookbook/serving-statistics-to-agents/safety.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ answer.
1. Give the server a credential to the API and the catalog that can read
public records and values and nothing else. With that credential, a
licensed microdata file is unreachable, which is the access rule of
[chapter 8 of the microdata cookbook](/cookbook/microdata-documentation/access).
the access chapter of the microdata cookbook.
2. Implement no tool that writes, deletes, submits, or triggers anything.
Mark every tool read-only in its annotations and say so in the
manifest. The annotation is a hint that clients may display; the
Expand Down
2 changes: 1 addition & 1 deletion cookbook/synthetic-data-for-sharing/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ scripts here measure, check, and document what they produce.
|---|---|
| This guide | How to produce, measure, document, and use synthetic microdata, in a sequence of practical steps. |
| [REaLTabFormer](https://github.com/worldbank/REaLTabFormer) | The program's generator for tabular and relational synthetic data. |
| [Practical Guide to AI-Ready Microdata Documentation](/cookbook/microdata-documentation/) | The documentation, access tiers, and disclosure control the synthetic file sits beside. |
| Practical Guide to AI-Ready Microdata Documentation | The documentation, access tiers, and disclosure control the synthetic file sits beside. |
| [Practical Guide to Monitoring Data Use](/cookbook/monitoring-data-use/) | Counting downloads and finding mentions of the synthetic file. |
| [Code](https://github.com/worldbank/ai4data) | Open-source software to deploy or adapt. |

Expand Down
8 changes: 4 additions & 4 deletions cookbook/synthetic-data-for-sharing/purpose.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ of what its synthetic files are for and what they must not be used for.
synthetic in its name, in its catalog record, and inside the data
itself.
4. Publish the statement with the access policy of the
[microdata cookbook](/cookbook/microdata-documentation/access), and
microdata cookbook, and
repeat it in every synthesis record ([chapter 6](./release.mdx)).

**Worked example.** The example organization's statement fits on one
Expand Down Expand Up @@ -149,7 +149,7 @@ that users do analyse.
inference, never the identification of a respondent in the file.
2. Where the organization uses partial synthesis as disclosure control,
document it in the public use file's disclosure control record
([microdata cookbook, chapter 8](/cookbook/microdata-documentation/access)),
(access chapter of the microdata cookbook),
with utility measured for the estimates users will make.
3. Keep the two products apart in the catalog, with different labels,
records, and terms of use.
Expand Down Expand Up @@ -182,14 +182,14 @@ other; what differs is the documentation and the use.
## World Bank examples

- The program's synthetic data workstream develops [REaLTabFormer](https://github.com/worldbank/REaLTabFormer), a transformer-based generator for tabular and relational data, placed under disclosure control (GSBPM 6.4) in the [GSBPM mapping](/docs/gsbpm-mapping).
- The [Microdata Library](https://microdata.worldbank.org/) access tiers and the [microdata cookbook's access chapter](/cookbook/microdata-documentation/access) set the workflow a synthetic file joins.
- The [Microdata Library](https://microdata.worldbank.org/) access tiers and the microdata cookbook's access chapter set the workflow a synthetic file joins.

## Resources

- [UNECE, Synthetic Data for Official Statistics: A Starter Guide](https://unece.org/statistics/publications/synthetic-data-official-statistics-starter-guide): the reference introduction for statistical organizations, with use cases and cautions.
- [REaLTabFormer](https://github.com/worldbank/REaLTabFormer): the program's generator for tabular and relational synthetic data (MIT).
- [synthpop](https://cran.r-project.org/package=synthpop): the R package for sequential synthesis with CART and parametric methods, with its own utility and disclosure measures.
- [Access chapter of the microdata cookbook](/cookbook/microdata-documentation/access): the access policy and tiers the synthetic file sits beside.
- Access chapter of the microdata cookbook: the access policy and tiers the synthetic file sits beside.

## Common mistakes

Expand Down
2 changes: 1 addition & 1 deletion cookbook/synthetic-data-for-sharing/relational.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ person histories is the alternative for panels with many waves.
## World Bank examples

- [REaLTabFormer](https://github.com/worldbank/REaLTabFormer) was built for relational data: a parent table model and a sequence-to-sequence child model, evaluated on household-person and similar structures.
- The [microdata cookbook's comparability chapter](/cookbook/microdata-documentation/rounds) documents the structure across rounds that a synthetic panel has to reproduce.
- The microdata cookbook's comparability chapter documents the structure across rounds that a synthetic panel has to reproduce.

## Resources

Expand Down
2 changes: 1 addition & 1 deletion cookbook/synthetic-data-for-sharing/release.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ label, and the terms of use ask users to keep both.
## World Bank examples

- The [Metadata Editor](https://github.com/worldbank/metadata-editor) and [NADA](https://nada.ihsn.org/) hold the record and the access type, with documentation files attached.
- The [microdata cookbook's access chapter](/cookbook/microdata-documentation/access) sets the tiers and the policy the release decision applies.
- The microdata cookbook's access chapter sets the tiers and the policy the release decision applies.

## Resources

Expand Down
4 changes: 2 additions & 2 deletions cookbook/synthetic-data-for-sharing/risk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ recorded review against the limits.
in a small area with a rare combination that occurs once in the
real file.
2. Record the limits in the survey's disclosure control documentation
([microdata cookbook, chapter 8](/cookbook/microdata-documentation/access)).
(access chapter of the microdata cookbook).
3. Review each file's report against the limits. Record the reviewer,
the date, and the decision in the synthesis record.

Expand Down Expand Up @@ -220,7 +220,7 @@ use, which address misuse, a different risk from disclosure.
## World Bank examples

- [REaLTabFormer](https://github.com/worldbank/REaLTabFormer) includes a distance-to-closest-record stopping criterion that limits memorization during training, the closest-record check applied at training time.
- The [microdata cookbook's access chapter](/cookbook/microdata-documentation/access) and the [sdcMicro practice guide](https://sdcpractice.readthedocs.io/) set the disclosure control practice the unit applies.
- The microdata cookbook's access chapter and the [sdcMicro practice guide](https://sdcpractice.readthedocs.io/) set the disclosure control practice the unit applies.

## Resources

Expand Down
2 changes: 1 addition & 1 deletion cookbook/synthetic-data-for-sharing/standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ the program's workstreams provide a tool, the guide uses it.
| [Metadata Editor](https://worldbank.github.io/metadata-editor-docs) and [NADA](https://nada.ihsn.org/) | Creating the record and publishing the file with its access type | Chapter 6 |
| [Creative Commons BY 4.0](https://creativecommons.org/licenses/by/4.0/) | The licence for open synthetic files | Chapter 6 |
| [UNECE, Synthetic Data for Official Statistics: A Starter Guide](https://unece.org/statistics/publications/synthetic-data-official-statistics-starter-guide) | The reference introduction and use cases for statistical organizations | Chapters [1](./purpose.mdx) and [7](./workflow.mdx) |
| [Access chapter of the microdata cookbook](/cookbook/microdata-documentation/access) | Tiers, disclosure control records, and the access workflow | Chapters 1, 4, 6, and 7 |
| Access chapter of the microdata cookbook | Tiers, disclosure control records, and the access workflow | Chapters 1, 4, 6, and 7 |

## Corrections

Expand Down
Loading
Loading