Skip to content

fix: add missing modelCard.properties to XML + Protobuf schemas #743

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wiebe-vandendriessche wants to merge 7 commits into
base: master
Choose a base branch
from
+108 −6
Open

fix: add missing modelCard.properties to XML + Protobuf schemas #743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ad3dc9e
fix: add properties field to ModelCard xml and proto to resolve misma…
wiebe-vandendriessche Dec 17, 2025
f5b3f90
fix: removed some unnecessary whitespace
wiebe-vandendriessche Dec 17, 2025
f1b7301
fix: bump version numbers in BOM schema files to 1.5.1, 1.6.2, and 1.7.1
wiebe-vandendriessche Jan 15, 2026
98eb26f
test: add tests for custom properties field in modelCard (json, xml, …
wiebe-vandendriessche Jan 16, 2026
af9df67
fix: add another custom property to ModelCard across JSON, XML, and p…
wiebe-vandendriessche Feb 9, 2026
2eb1645
Merge branch 'master' into fix/modelcard-missing-properties
wiebe-vandendriessche Feb 9, 2026
2deea41
Merge branch 'master' into fix/modelcard-missing-properties
wiebe-vandendriessche Feb 9, 2026
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
2 changes: 2 additions & 0 deletions schema/bom-1.5.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1009,6 +1009,8 @@ message ModelCard {
optional QuantitativeAnalysis quantitativeAnalysis = 3;
// What considerations should be taken into account regarding the model's construction, training, and application?
optional ModelCardConsiderations considerations = 4;
// Specifies optional, custom, properties
repeated Property properties = 5;

message ModelParameters {
// The overall approach to learning used by the model for problem solving.
Expand Down
12 changes: 11 additions & 1 deletion schema/bom-1.5.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ limitations under the License.
targetNamespace="http://cyclonedx.org/schema/bom/1.5"
vc:minVersion="1.0"
vc:maxVersion="1.1"
version="1.5.0">
version="1.5.1">

<xs:import namespace="http://cyclonedx.org/schema/spdx" schemaLocation="http://cyclonedx.org/schema/spdx"/>

Expand Down Expand Up @@ -3008,6 +3008,16 @@ limitations under the License.
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="properties" type="bom:propertiesType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Provides the ability to document properties in a name/value store.
This provides flexibility to include data not officially supported in the standard
without having to use additional namespaces or create extensions. Property names
of interest to the general public are encouraged to be registered in the
CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
Formal registration is OPTIONAL.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="bom-ref" type="bom:refType">
<xs:annotation>
Expand Down
2 changes: 2 additions & 0 deletions schema/bom-1.6.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1152,6 +1152,8 @@ message ModelCard {
optional QuantitativeAnalysis quantitativeAnalysis = 3;
// What considerations should be taken into account regarding the model's construction, training, and application?
optional ModelCardConsiderations considerations = 4;
// Specifies optional, custom, properties
repeated Property properties = 5;

message ModelParameters {
// The overall approach to learning used by the model for problem-solving.
Expand Down
12 changes: 11 additions & 1 deletion schema/bom-1.6.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ limitations under the License.
targetNamespace="http://cyclonedx.org/schema/bom/1.6"
vc:minVersion="1.0"
vc:maxVersion="1.1"
version="1.6.1">
version="1.6.2">

<xs:import namespace="http://cyclonedx.org/schema/spdx" schemaLocation="http://cyclonedx.org/schema/spdx"/>

Expand Down Expand Up @@ -3386,6 +3386,16 @@ limitations under the License.
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="properties" type="bom:propertiesType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Provides the ability to document properties in a name/value store.
This provides flexibility to include data not officially supported in the standard
without having to use additional namespaces or create extensions. Property names
of interest to the general public are encouraged to be registered in the
CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
Formal registration is OPTIONAL.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="bom-ref" type="bom:refType">
<xs:annotation>
Expand Down
2 changes: 2 additions & 0 deletions schema/bom-1.7.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1254,6 +1254,8 @@ message ModelCard {
optional QuantitativeAnalysis quantitativeAnalysis = 3;
// What considerations should be taken into account regarding the model's construction, training, and application?
optional ModelCardConsiderations considerations = 4;
// Specifies optional, custom, properties
repeated Property properties = 5;

message ModelParameters {
// The overall approach to learning used by the model for problem-solving.
Expand Down
12 changes: 11 additions & 1 deletion schema/bom-1.7.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ limitations under the License.
targetNamespace="http://cyclonedx.org/schema/bom/1.7"
vc:minVersion="1.0"
vc:maxVersion="1.1"
version="1.7.0">
version="1.7.1">

<xs:import namespace="http://cyclonedx.org/schema/spdx" schemaLocation="http://cyclonedx.org/schema/spdx"/>

Expand Down Expand Up @@ -3629,6 +3629,16 @@ limitations under the License.
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="properties" type="bom:propertiesType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Provides the ability to document properties in a name/value store.
This provides flexibility to include data not officially supported in the standard
without having to use additional namespaces or create extensions. Property names
of interest to the general public are encouraged to be registered in the
CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
Formal registration is OPTIONAL.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="bom-ref" type="bom:refType">
<xs:annotation>
Expand Down
12 changes: 11 additions & 1 deletion tools/src/test/resources/1.5/valid-machine-learning-1.5.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,17 @@
"mitigationStrategy": "With respect to the benefits and harms outlined, please describe any mitigation strategy implemented."
}
]
}
},
"properties": [
{
"name": "modelcard:custom-property",
"value": "custom-value"
},
{
"name": "modelcard:another-custom-property",
"value": "another-custom-value"
}
]
}
}
]
Expand Down
8 changes: 8 additions & 0 deletions tools/src/test/resources/1.5/valid-machine-learning-1.5.textproto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,13 @@ components {
mitigationStrategy: "With respect to the benefits and harms outlined, please describe any mitigation strategy implemented."
}
}
properties: {
name: "modelcard:custom-property"
value: "custom-value"
}
properties: {
name: "modelcard:another-custom-property"
value: "another-custom-value"
}
}
}
4 changes: 4 additions & 0 deletions tools/src/test/resources/1.5/valid-machine-learning-1.5.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,10 @@
</fairnessAssessment>
</fairnessAssessments>
</considerations>
<properties>
<property name="modelcard:custom-property">custom-value</property>
<property name="modelcard:another-custom-property">another-custom-value</property>
</properties>
</modelCard>
</component>
</components>
Expand Down
12 changes: 11 additions & 1 deletion tools/src/test/resources/1.6/valid-machine-learning-1.6.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,17 @@
"mitigationStrategy": "With respect to the benefits and harms outlined, please describe any mitigation strategy implemented."
}
]
}
},
"properties": [
{
"name": "modelcard:custom-property",
"value": "custom-value"
},
{
"name": "modelcard:another-custom-property",
"value": "another-custom-value"
}
]
}
}
]
Expand Down
8 changes: 8 additions & 0 deletions tools/src/test/resources/1.6/valid-machine-learning-1.6.textproto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,5 +77,13 @@ components {
mitigationStrategy: "With respect to the benefits and harms outlined, please describe any mitigation strategy implemented."
}
}
properties: {
name: "modelcard:custom-property"
value: "custom-value"
}
properties: {
name: "modelcard:another-custom-property"
value: "another-custom-value"
}
}
}
4 changes: 4 additions & 0 deletions tools/src/test/resources/1.6/valid-machine-learning-1.6.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,10 @@
</fairnessAssessment>
</fairnessAssessments>
</considerations>
<properties>
<property name="modelcard:custom-property">custom-value</property>
<property name="modelcard:another-custom-property">another-custom-value</property>
</properties>
</modelCard>
</component>
</components>
Expand Down
12 changes: 11 additions & 1 deletion tools/src/test/resources/1.7/valid-machine-learning-1.7.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,17 @@
"mitigationStrategy": "With respect to the benefits and harms outlined, please describe any mitigation strategy implemented."
}
]
}
},
"properties": [
{
"name": "modelcard:custom-property",
"value": "custom-value"
},
{
"name": "modelcard:another-custom-property",
"value": "another-custom-value"
}
]
}
}
]
Expand Down
8 changes: 8 additions & 0 deletions tools/src/test/resources/1.7/valid-machine-learning-1.7.textproto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,13 @@ components: {
mitigationStrategy: "With respect to the benefits and harms outlined, please describe any mitigation strategy implemented."
}
}
properties: {
name: "modelcard:custom-property"
value: "custom-value"
}
properties: {
name: "modelcard:another-custom-property"
value: "another-custom-value"
}
}
}
4 changes: 4 additions & 0 deletions tools/src/test/resources/1.7/valid-machine-learning-1.7.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,10 @@
</fairnessAssessment>
</fairnessAssessments>
</considerations>
<properties>
<property name="modelcard:custom-property">custom-value</property>
<property name="modelcard:another-custom-property">another-custom-value</property>
</properties>
</modelCard>
</component>
</components>
Expand Down