diff --git a/hello_world/README.md b/hello_world/README.md index bdf0d93..a3ab9b4 100644 --- a/hello_world/README.md +++ b/hello_world/README.md @@ -1,5 +1,10 @@ # Hello World MLCube +## Optional run audit manifest +This example includes `audit_manifest.example.json` as an optional sidecar for recording reproducible, audit-safe run metadata. It is not required by MLCube runners and does not change task execution. + +Use this kind of manifest to record the task, runner, image, inputs, outputs, and result status for a run. Do not store raw secrets, tokens, private paths, or sensitive arguments in public audit manifests. + ## Create and initialize python environment ``` virtualenv -p python3 ./env && source ./env/bin/activate && pip install mlcube-docker mlcube-singularity mlcube-ssh diff --git a/hello_world/audit_manifest.example.json b/hello_world/audit_manifest.example.json new file mode 100644 index 0000000..b7aab1c --- /dev/null +++ b/hello_world/audit_manifest.example.json @@ -0,0 +1,16 @@ +{ + "schema_version": "mlcube.run_audit.v1", + "example": "hello_world", + "mlcube_task": "hello", + "runner": "docker", + "image": "mlcommons/hello_world:0.0.1", + "inputs": [ + "workspace/names/alice.txt" + ], + "outputs": [ + "workspace/chats/chat_with_alice.txt" + ], + "claim_status": "diagnostic", + "redaction_status": "safe_for_public_log", + "notes": "Optional sidecar manifest for recording reproducible, audit-safe MLCube run metadata." +}