Skip to content

Proposal: add optional audit manifest example #69

Description

@mindbomber

Proposal

Would this examples repo be open to a tiny audit/provenance manifest example next to one of the simple MLCubes, such as hello_world or matmul?

Related proposals:

The examples repo seems like a low-risk place to demonstrate the idea without changing MLCube runtime behavior, schemas, or generated templates.

Suggested example file

For example:

hello_world/
  audit_manifest.example.json

Example contents:

{
  "schema_version": "mlcube.run_audit.v1",
  "example": "hello_world",
  "mlcube_task": "hello_world",
  "runner": "docker",
  "inputs": ["workspace/parameters"],
  "outputs": ["workspace/output.txt"],
  "claim_status": "diagnostic",
  "redaction_status": "safe_for_public_log",
  "notes": "Example sidecar manifest for recording reproducible, audit-safe MLCube run metadata."
}

Why this may help

  • gives users a concrete pattern for recording run provenance and result status
  • keeps the manifest optional and separate from runtime behavior
  • helps distinguish diagnostic/internal runs from public/reportable artifacts
  • encourages audit-safe metadata without storing raw secrets, private paths, tokens, or sensitive arguments

Possible first PR scope

If maintainers are interested, I can prepare a small PR that:

  • adds audit_manifest.example.json to hello_world or matmul
  • adds one short README note explaining that the manifest is optional
  • does not change code, runner behavior, or benchmark outputs

This is motivated by AANA work around audit-safe AI evaluation artifacts, but the contribution would be generic to MLCube examples and would not require AANA as a dependency.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions