Add hello world audit manifest example#70
Open
mindbomber wants to merge 1 commit into
Open
Conversation
|
MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds an optional audit/provenance manifest example to the
hello_worldMLCube example.The manifest is a sidecar example only. It does not change MLCube runner behavior, task execution, or benchmark outputs.
Why
This gives users a concrete pattern for recording reproducible, audit-safe run metadata such as:
It also documents that public audit manifests should not store raw secrets, tokens, private paths, or sensitive arguments.
Related issue: #69
Related core proposal: mlcommons/mlcube#367
Related cookiecutter proposal: mlcommons/mlcube_cookiecutter#10
Validation
hello_world/audit_manifest.example.jsonwith Pythonjson.loadsgit diff --check