docs: add ML model handoff MBOM example#63
Open
Rul1an wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
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.
| { | ||
| "ref": "component-support-triage-service", | ||
| "dependsOn": [ | ||
| "pkg:huggingface/example/support-ticket-classifier@1.0.0" |
| @@ -0,0 +1,346 @@ | |||
| { | |||
| "$schema": "http://cyclonedx.org/schema/bom-1.6.schema.json", | |||
faa123a to
940cde1
Compare
Signed-off-by: Rul1an <roelschuurkes@gmail.com>
940cde1 to
132a463
Compare
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 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 asMBOM/helloworld-c/mbom.json, while using multiple tasks because the ML handoff flow has distinct training, evaluation, and handoff phases.Changes
MBOM/ml-model-handoff/mbom.json, a schema-valid CycloneDX 1.6 example.MBOM/README.mdindex covering the existing Hello World C example and this example.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=falseThe AJV run reports expected unknown-format warnings for formats not loaded by ajv-cli, then validates the BOM as valid.