Skip to content

docs: add ML model handoff MBOM example#63

Open
Rul1an wants to merge 1 commit into
CycloneDX:masterfrom
Rul1an:codex/ml-model-handoff-mbom
Open

docs: add ML model handoff MBOM example#63
Rul1an wants to merge 1 commit into
CycloneDX:masterfrom
Rul1an:codex/ml-model-handoff-mbom

Conversation

@Rul1an
Copy link
Copy Markdown

@Rul1an Rul1an commented May 27, 2026

Summary

Adds a CycloneDX MBOM example for a fictional ML model handoff workflow.

The example uses formulation[] to show how a model training, evaluation, and evidence-handoff process can be represented with CycloneDX workflows, tasks, steps, commands, inputs, and outputs. It follows the same broad MBOM formulation shape as MBOM/helloworld-c/mbom.json, while using multiple tasks because the ML handoff flow has distinct training, evaluation, and handoff phases.

Changes

  • Add MBOM/ml-model-handoff/mbom.json, a schema-valid CycloneDX 1.6 example.
  • Add a local README for the ML model handoff example.
  • Add an MBOM/README.md index covering the existing Hello World C example and this example.
  • Add MBOM to the repository root BOM type table.

Notes

All model names, dataset names, metric values, workflow commands, and URLs are fictional and illustrative. They demonstrate CycloneDX structure only and do not make claims about a real model, dataset, benchmark, safety posture, compliance status, or deployment.

Refs #55.

Validation

jq . MBOM/ml-model-handoff/mbom.json

git diff --check

npx --yes ajv-cli@5.0.0 validate \
  -s bom-1.6.schema.json \
  -r spdx.schema.json \
  -r jsf-0.82.schema.json \
  -r cryptography-defs.schema.json \
  -d MBOM/ml-model-handoff/mbom.json \
  --strict=false

The AJV run reports expected unknown-format warnings for formats not loaded by ajv-cli, then validates the BOM as valid.

Copilot AI review requested due to automatic review settings May 27, 2026 14:05
@Rul1an Rul1an requested a review from a team as a code owner May 27, 2026 14:05
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds a new Manufacturing Bill of Materials (MBOM) section and an ML model handoff example to demonstrate CycloneDX MBOM/formulation workflows.

Changes:

  • Adds MBOM to the top-level README BOM-type index.
  • Introduces an MBOM landing README with example links.
  • Adds an “ML Model Handoff” MBOM example (README + CycloneDX JSON).

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
README.md Adds MBOM to the BOM type index table.
MBOM/README.md Introduces MBOM overview and links to MBOM examples.
MBOM/ml-model-handoff/README.md Documents the ML model handoff MBOM example and what it demonstrates.
MBOM/ml-model-handoff/mbom.json Provides the CycloneDX MBOM JSON illustrating model training/eval/handoff workflows.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread MBOM/ml-model-handoff/mbom.json Outdated
{
"ref": "component-support-triage-service",
"dependsOn": [
"pkg:huggingface/example/support-ticket-classifier@1.0.0"
Comment thread MBOM/ml-model-handoff/mbom.json Outdated
@@ -0,0 +1,346 @@
{
"$schema": "http://cyclonedx.org/schema/bom-1.6.schema.json",
@Rul1an Rul1an force-pushed the codex/ml-model-handoff-mbom branch from faa123a to 940cde1 Compare May 27, 2026 14:08
Signed-off-by: Rul1an <roelschuurkes@gmail.com>
@Rul1an Rul1an force-pushed the codex/ml-model-handoff-mbom branch from 940cde1 to 132a463 Compare May 27, 2026 14:11
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.

2 participants