Skip to content

Fields almost aligned with whitepaper - #205

Merged
mccalluc merged 23 commits into
mainfrom
195-trust-assumptions-and-last-bits
Sep 11, 2026
Merged

mccalluc merged 23 commits into
mainfrom
195-trust-assumptions-and-last-bits

Conversation

@mccalluc

@mccalluc mccalluc commented Jul 16, 2026 •

Copy link
Copy Markdown
Collaborator

Nearing the final changes to the schema necessary to match the whitepaper, and update all the data files to validate against the schema.

TODO: model_name_details, actors, data_source_type: Decide how the information currently in these fields should be mapped.

Output of dump.py:

url_slug
deployment
  basic
    name
    data_curators
    description
    intended_use
    data_product_type
    data_product_region
    data_product_sector
    publication_date
  dp_variant
    variant_name
    data_domain
    unprotected_quantities
  privacy_loss
    privacy_unit
    privacy_unit_details
    number_of_privacy_units
    privacy_parameters
      epsilon
      delta
      rho
    privacy_parameters_details
  deployment_model
    model_name
    model_name_details
    trust_assumptions
    actors
    release_type
    release_type_details
    data_source_type
    data_source_type_details
    access_type
    access_type_details
  implementation
    preprocessing_and_hyperparameter_tuning
    mechanisms
    composition
    post_processing
    justification
    utility
    additional_information
  administrative
    sources
    status
    registry_authors
    tier

Discrepancies between this and the whitepaper:

  • Schema has url_slug at the top level. It's not part of the user-visible data, so it seems good to keep it out of deployment.
  • Swap data_product_sector and publication_date so the three data_product_* fields are together. (Doesn't matter for json schema validation, but we also check the order of the keys, and the keys are displayed in the given order in the UI, so it does have consequences.)
  • data_curators includes both "data_curator_name" and "data_curator_type"
  • privacy_unit_details: Use "details" rather than "description" for consistency. I believe James confirmed verbally that the whitepaper should be corrected.
  • data_source_type rather than just "data source". "Type" seems more appropriate for an enumerated field like this.
  • model_name_details, actors, data_source_type retained because I was unsure where to move the information they contain.
  • "Additional Information" is set off from the rest of the "Implementation" fields in the whitepaper table. I believe this is just a formatting quirk.
  • Add sources to administrative. (and Support evidence source #172 will start to move sources the more structured evidence_sources)

Base automatically changed from 195-trust-assumptions to main July 29, 2026 17:07
@mccalluc mccalluc changed the title Final schema changes Final schema updates? Jul 31, 2026
@mccalluc mccalluc changed the title Final schema updates? Fields almost aligned with whitepaper Jul 31, 2026
@mccalluc
mccalluc marked this pull request as ready for review July 31, 2026 18:14
@mccalluc
mccalluc requested a review from tercer August 3, 2026 22:29

@tercer tercer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great progress

@tercer tercer self-assigned this Sep 11, 2026
@mccalluc

Copy link
Copy Markdown
Collaborator Author

James verbally approves!

@mccalluc
mccalluc enabled auto-merge (squash) September 11, 2026 16:53
@mccalluc
mccalluc disabled auto-merge September 11, 2026 17:08
@mccalluc
mccalluc enabled auto-merge (squash) September 11, 2026 17:09
@mccalluc
mccalluc disabled auto-merge September 11, 2026 17:12
@mccalluc
mccalluc merged commit 0c38378 into main Sep 11, 2026
1 check passed
@mccalluc
mccalluc deleted the 195-trust-assumptions-and-last-bits branch September 11, 2026 17:12
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.

Move status and tier to administrative Move post-processing and composition to implementation

2 participants