in the CycloneDX 2.0 documentationals description, $comment, meta:enum there are string literals, references to properties, and other "special elements" used, that shall be given some semantics - and they need streamlining.
in the JSON files, search for regex:
examples
|
"description": "A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component of type `machine-learning-model` and must not be specified for other component types.", |
here the string machine-learning-model refers to a specific string literal which shall be used for the field type of a component.
|
"description": "For an activity node, the behavior performed, drawn from the taxonomy. Mutually exclusive with 'ref' and 'graph'." |
here the ref and graph are referring to other fields in the object.
- and so on ...
goal:
- Referred fields are markdown code blocks -- start and stop with a "`"
- string literal values are marked as such by using double quotes -- like
"some_value"
- if a value refers to a property, then the code blocks hall make this clear --
myField="some_value" or myOther=false
example fixes:
- "description": "A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component of type `machine-learning-model` and must not be specified for other component types.",
+ "description": "A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component with `type=\"machine-learning-model\"` and must not be specified for other component types.",
- "description": "For an activity node, the behavior performed, drawn from the taxonomy. Mutually exclusive with 'ref' and 'graph'."
+ "description": "For an activity node, the behavior performed, drawn from the taxonomy. Mutually exclusive with `ref` and `graph`."
in the CycloneDX 2.0 documentationals
description,$comment,meta:enumthere are string literals, references to properties, and other "special elements" used, that shall be given some semantics - and they need streamlining.in the JSON files, search for regex:
examples
specification/schema/2.0/model/cyclonedx-ai-modelcard-2.0.schema.json
Line 12 in a1c8aeb
here the string
machine-learning-modelrefers to a specific string literal which shall be used for the fieldtypeof a component.specification/schema/2.0/model/cyclonedx-behavior-2.0.schema.json
Line 295 in a1c8aeb
here the
refandgraphare referring to other fields in the object.goal:
"some_value"myField="some_value"ormyOther=falseexample fixes: