Skip to content

Commit ad3dc9e

Browse files
fix: add properties field to ModelCard xml and proto to resolve mismatch with json
Signed-off-by: wievdndr <wiebe.vandendriessche@ugent.be>
1 parent 248a05f commit ad3dc9e

6 files changed

Lines changed: 37 additions & 1 deletion

File tree

schema/bom-1.5.proto

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1009,6 +1009,8 @@ message ModelCard {
10091009
optional QuantitativeAnalysis quantitativeAnalysis = 3;
10101010
// What considerations should be taken into account regarding the model's construction, training, and application?
10111011
optional ModelCardConsiderations considerations = 4;
1012+
// Specifies optional, custom, properties
1013+
repeated Property properties = 5;
10121014

10131015
message ModelParameters {
10141016
// The overall approach to learning used by the model for problem solving.

schema/bom-1.5.xsd

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2998,7 +2998,7 @@ limitations under the License.
29982998
describe any mitigation strategy implemented.
29992999
</xs:documentation>
30003000
</xs:annotation>
3001-
</xs:element>
3001+
</xs:element>
30023002
</xs:sequence>
30033003
</xs:complexType>
30043004
</xs:element>
@@ -3008,6 +3008,16 @@ limitations under the License.
30083008
</xs:sequence>
30093009
</xs:complexType>
30103010
</xs:element>
3011+
<xs:element name="properties" type="bom:propertiesType" minOccurs="0" maxOccurs="1">
3012+
<xs:annotation>
3013+
<xs:documentation>Provides the ability to document properties in a name/value store.
3014+
This provides flexibility to include data not officially supported in the standard
3015+
without having to use additional namespaces or create extensions. Property names
3016+
of interest to the general public are encouraged to be registered in the
3017+
CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
3018+
Formal registration is OPTIONAL.</xs:documentation>
3019+
</xs:annotation>
3020+
</xs:element>
30113021
</xs:sequence>
30123022
<xs:attribute name="bom-ref" type="bom:refType">
30133023
<xs:annotation>

schema/bom-1.6.proto

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1152,6 +1152,8 @@ message ModelCard {
11521152
optional QuantitativeAnalysis quantitativeAnalysis = 3;
11531153
// What considerations should be taken into account regarding the model's construction, training, and application?
11541154
optional ModelCardConsiderations considerations = 4;
1155+
// Specifies optional, custom, properties
1156+
repeated Property properties = 5;
11551157

11561158
message ModelParameters {
11571159
// The overall approach to learning used by the model for problem-solving.

schema/bom-1.6.xsd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3386,6 +3386,16 @@ limitations under the License.
33863386
</xs:sequence>
33873387
</xs:complexType>
33883388
</xs:element>
3389+
<xs:element name="properties" type="bom:propertiesType" minOccurs="0" maxOccurs="1">
3390+
<xs:annotation>
3391+
<xs:documentation>Provides the ability to document properties in a name/value store.
3392+
This provides flexibility to include data not officially supported in the standard
3393+
without having to use additional namespaces or create extensions. Property names
3394+
of interest to the general public are encouraged to be registered in the
3395+
CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
3396+
Formal registration is OPTIONAL.</xs:documentation>
3397+
</xs:annotation>
3398+
</xs:element>
33893399
</xs:sequence>
33903400
<xs:attribute name="bom-ref" type="bom:refType">
33913401
<xs:annotation>

schema/bom-1.7.proto

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1254,6 +1254,8 @@ message ModelCard {
12541254
optional QuantitativeAnalysis quantitativeAnalysis = 3;
12551255
// What considerations should be taken into account regarding the model's construction, training, and application?
12561256
optional ModelCardConsiderations considerations = 4;
1257+
// Specifies optional, custom, properties
1258+
repeated Property properties = 5;
12571259

12581260
message ModelParameters {
12591261
// The overall approach to learning used by the model for problem-solving.

schema/bom-1.7.xsd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3629,6 +3629,16 @@ limitations under the License.
36293629
</xs:sequence>
36303630
</xs:complexType>
36313631
</xs:element>
3632+
<xs:element name="properties" type="bom:propertiesType" minOccurs="0" maxOccurs="1">
3633+
<xs:annotation>
3634+
<xs:documentation>Provides the ability to document properties in a name/value store.
3635+
This provides flexibility to include data not officially supported in the standard
3636+
without having to use additional namespaces or create extensions. Property names
3637+
of interest to the general public are encouraged to be registered in the
3638+
CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
3639+
Formal registration is OPTIONAL.</xs:documentation>
3640+
</xs:annotation>
3641+
</xs:element>
36323642
</xs:sequence>
36333643
<xs:attribute name="bom-ref" type="bom:refType">
36343644
<xs:annotation>

0 commit comments

Comments
 (0)