Skip to content

add metadata to saved params json file#306

Merged
yiwen-h merged 1 commit intomainfrom
299_add_metadata_to_saved_params
Mar 7, 2025
Merged

add metadata to saved params json file#306
yiwen-h merged 1 commit intomainfrom
299_add_metadata_to_saved_params

Conversation

@yiwen-h
Copy link
Member

@yiwen-h yiwen-h commented Mar 4, 2025

Closes #299

Note that with this PR, we will be adding metadata to two different files. For example for a scenario with name example in v3.2, for provider XYZ, with runtime runtime, metadata will be added to both of these files in the results storage container:

  • old format of results file, saved in prod/v3.2/XYZ/example-runtime.json.gz - we will deprecate this in the medium to long term
  • new params.json file, saved in aggregated-model-results/v3.2/XYZ/example/runtime/params.json

Does this work @matt-dray ?

@yiwen-h yiwen-h requested a review from tomjemmett March 4, 2025 16:29
@yiwen-h yiwen-h self-assigned this Mar 4, 2025
@codecov
Copy link

codecov bot commented Mar 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (022aa8b) to head (16541b7).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #306   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           18        18           
  Lines          999      1002    +3     
=========================================
+ Hits           999      1002    +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Member

@tomjemmett tomjemmett left a comment

Choose a reason for hiding this comment

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

I thought we was going to add the metadata as columns to the parquet files? The metadata will be "lost" as soon as a file is downloaded as it's only a function of azure storage.

@matt-dray
Copy link
Contributor

Both, basically. Exposing the metadata on params.json is still needed to help us produce things like the outputs reports, the mitigator comparison app and the tagged runs report.

@yiwen-h
Copy link
Member Author

yiwen-h commented Mar 7, 2025

Yes we did that already here @tomjemmett #296

@tomjemmett
Copy link
Member

Ah cool, must have forgot or missed that! Checked for issues, but if it's already done... 😝

@yiwen-h yiwen-h merged commit 252d690 into main Mar 7, 2025
3 checks passed
@yiwen-h yiwen-h deleted the 299_add_metadata_to_saved_params branch March 7, 2025 09:38
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.

add metadata previously in results json file to saved params.json

3 participants