Skip to content

[codex] fix docs api correctness#33

Draft
vvv214 wants to merge 1 commit into
google:mainfrom
vvv214:codex/fix-docs-api-correctness
Draft

[codex] fix docs api correctness#33
vvv214 wants to merge 1 commit into
google:mainfrom
vvv214:codex/fix-docs-api-correctness

Conversation

@vvv214

@vvv214 vvv214 commented Jun 17, 2026

Copy link
Copy Markdown

Summary

This draft PR fixes documentation/API mismatches surfaced while reviewing the public repo.

  • update README links from the old documentation/ directory to docs/
  • update the in-memory API signature to use the current mechanism type/default
  • replace stale AIMConfig(seed=..., rounds=...) example parameters with max_rounds
  • clarify the CLI --seed limitation for bit-for-bit reproducibility
  • make the record-level DP assumption explicit and warn that multi-row users need caller-enforced contribution bounds

Why

The docs currently reference moved paths and show constructor arguments that are not fields on AIMMechanism. The CLI seed text also overstates reproducibility because the in-memory generator creates a fresh np.random.default_rng() internally.

Validation

  • rg -n "documentation/|DiscreteMechanismConfig|seed=42|rounds=50|fixed random seed|bit-for-bit|record-level differential privacy|different \\*\\*privacy unit" README.md docs/in_memory_api.md docs/data_and_terminology.md
    • only returns the newly clarified record-level and bit-for-bit limitation text

Full pytest was not run because this is a docs-only PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant