Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions hello_world/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
16 changes: 16 additions & 0 deletions hello_world/audit_manifest.example.json
Original file line number Diff line number Diff line change
@@ -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."
}
Loading