diff --git a/schema/bom-1.5.proto b/schema/bom-1.5.proto index d99c1a9c..a6ecd79d 100644 --- a/schema/bom-1.5.proto +++ b/schema/bom-1.5.proto @@ -1,5 +1,5 @@ syntax = "proto3"; -package cyclonedx.v1_5; +package cyclonedx.v1_5; // 1.5.1 import "google/protobuf/timestamp.proto"; // Specifies attributes of the text @@ -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. diff --git a/schema/bom-1.5.xsd b/schema/bom-1.5.xsd index 0651bcdd..8a541afb 100644 --- a/schema/bom-1.5.xsd +++ b/schema/bom-1.5.xsd @@ -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"> @@ -2885,7 +2885,7 @@ limitations under the License. - + @@ -2897,7 +2897,7 @@ limitations under the License. - + @@ -2911,7 +2911,7 @@ limitations under the License. - + @@ -2923,7 +2923,7 @@ limitations under the License. - + @@ -3008,6 +3008,16 @@ limitations under the License. + + + 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. + + diff --git a/schema/bom-1.6.proto b/schema/bom-1.6.proto index 208c5992..737a133a 100644 --- a/schema/bom-1.6.proto +++ b/schema/bom-1.6.proto @@ -1,5 +1,5 @@ syntax = "proto3"; -package cyclonedx.v1_6; // version 1.6.1 +package cyclonedx.v1_6; // version 1.6.2 import "google/protobuf/timestamp.proto"; // Specifies attributes of the text @@ -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. diff --git a/schema/bom-1.6.xsd b/schema/bom-1.6.xsd index 89813217..4f7c2f91 100644 --- a/schema/bom-1.6.xsd +++ b/schema/bom-1.6.xsd @@ -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"> @@ -3256,7 +3256,7 @@ limitations under the License. - + @@ -3268,7 +3268,7 @@ limitations under the License. - + @@ -3282,7 +3282,7 @@ limitations under the License. - + @@ -3294,7 +3294,7 @@ limitations under the License. - + @@ -3386,6 +3386,16 @@ limitations under the License. + + + 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. + + diff --git a/schema/bom-1.7.proto b/schema/bom-1.7.proto index a618b926..5a1dc6c8 100644 --- a/schema/bom-1.7.proto +++ b/schema/bom-1.7.proto @@ -1,5 +1,5 @@ syntax = "proto3"; -package cyclonedx.v1_7; +package cyclonedx.v1_7; // 1.7.1 import "google/protobuf/timestamp.proto"; // Specifies attributes of the text @@ -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. diff --git a/schema/bom-1.7.xsd b/schema/bom-1.7.xsd index c2c725ef..59111cba 100644 --- a/schema/bom-1.7.xsd +++ b/schema/bom-1.7.xsd @@ -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"> @@ -3499,7 +3499,7 @@ limitations under the License. - + @@ -3511,7 +3511,7 @@ limitations under the License. - + @@ -3525,7 +3525,7 @@ limitations under the License. - + @@ -3537,7 +3537,7 @@ limitations under the License. - + @@ -3629,6 +3629,16 @@ limitations under the License. + + + 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. + + diff --git a/tools/src/test/resources/1.5/valid-machine-learning-1.5.json b/tools/src/test/resources/1.5/valid-machine-learning-1.5.json index 59dc3cee..f16696af 100644 --- a/tools/src/test/resources/1.5/valid-machine-learning-1.5.json +++ b/tools/src/test/resources/1.5/valid-machine-learning-1.5.json @@ -60,16 +60,20 @@ }, "considerations": { "users": [ - "Who are the intended users of the model?" + "Who are the intended users of the model?", + "Data scientists and ML researchers" ], "useCases": [ - "Who are the intended users of the model?" + "Who are the intended users of the model?", + "Text-to-image generation for creative applications" ], "technicalLimitations": [ - "What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?" + "What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?", + "Limited performance on non-photographic styles" ], "performanceTradeoffs": [ - "What are the known tradeoffs in accuracy/performance of the model?" + "What are the known tradeoffs in accuracy/performance of the model?", + "Higher resolution output requires more computational resources" ], "ethicalConsiderations": [ { @@ -85,7 +89,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" + } + ] } } ] diff --git a/tools/src/test/resources/1.5/valid-machine-learning-1.5.textproto b/tools/src/test/resources/1.5/valid-machine-learning-1.5.textproto index 4e54321d..a7e6e0d3 100644 --- a/tools/src/test/resources/1.5/valid-machine-learning-1.5.textproto +++ b/tools/src/test/resources/1.5/valid-machine-learning-1.5.textproto @@ -48,9 +48,13 @@ components { } considerations: { users: "Who are the intended users of the model?" + users: "Data scientists and ML researchers" useCases: "Who are the intended users of the model?" + useCases: "Text-to-image generation for creative applications" technicalLimitations: "What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?" + technicalLimitations: "Limited performance on non-photographic styles" performanceTradeoffs: "What are the known tradeoffs in accuracy/performance of the model?" + performanceTradeoffs: "Higher resolution output requires more computational resources" ethicalConsiderations: { name: "The name of the risk" mitigationStrategy: "Strategy used to address this risk" @@ -62,5 +66,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" + } } } diff --git a/tools/src/test/resources/1.5/valid-machine-learning-1.5.xml b/tools/src/test/resources/1.5/valid-machine-learning-1.5.xml index 7c541ecb..6756ccb7 100644 --- a/tools/src/test/resources/1.5/valid-machine-learning-1.5.xml +++ b/tools/src/test/resources/1.5/valid-machine-learning-1.5.xml @@ -61,15 +61,19 @@ Who are the intended users of the model? + Data scientists and ML researchers Who are the intended users of the model? + Text-to-image generation for creative applications What are the known technical limitations of the model? + Limited performance on non-photographic styles What are the known tradeoffs in accuracy/performance of the model? + Higher resolution output requires more computational resources @@ -86,6 +90,10 @@ + + custom-value + another-custom-value + diff --git a/tools/src/test/resources/1.6/valid-machine-learning-1.6.json b/tools/src/test/resources/1.6/valid-machine-learning-1.6.json index dbd0ea7b..fcd0264a 100644 --- a/tools/src/test/resources/1.6/valid-machine-learning-1.6.json +++ b/tools/src/test/resources/1.6/valid-machine-learning-1.6.json @@ -62,16 +62,20 @@ }, "considerations": { "users": [ - "Who are the intended users of the model?" + "Who are the intended users of the model?", + "Data scientists and ML researchers" ], "useCases": [ - "Who are the intended users of the model?" + "Who are the intended users of the model?", + "Text-to-image generation for creative applications" ], "technicalLimitations": [ - "What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?" + "What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?", + "Limited performance on non-photographic styles" ], "performanceTradeoffs": [ - "What are the known tradeoffs in accuracy/performance of the model?" + "What are the known tradeoffs in accuracy/performance of the model?", + "Higher resolution output requires more computational resources" ], "ethicalConsiderations": [ { @@ -87,7 +91,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" + } + ] } } ] diff --git a/tools/src/test/resources/1.6/valid-machine-learning-1.6.textproto b/tools/src/test/resources/1.6/valid-machine-learning-1.6.textproto index 54452d65..6ae5f0e9 100644 --- a/tools/src/test/resources/1.6/valid-machine-learning-1.6.textproto +++ b/tools/src/test/resources/1.6/valid-machine-learning-1.6.textproto @@ -63,9 +63,13 @@ components { } considerations: { users: "Who are the intended users of the model?" + users: "Data scientists and ML researchers" useCases: "Who are the intended users of the model?" + useCases: "Text-to-image generation for creative applications" technicalLimitations: "What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?" + technicalLimitations: "Limited performance on non-photographic styles" performanceTradeoffs: "What are the known tradeoffs in accuracy/performance of the model?" + performanceTradeoffs: "Higher resolution output requires more computational resources" ethicalConsiderations: { name: "The name of the risk" mitigationStrategy: "Strategy used to address this risk" @@ -77,5 +81,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" + } } } diff --git a/tools/src/test/resources/1.6/valid-machine-learning-1.6.xml b/tools/src/test/resources/1.6/valid-machine-learning-1.6.xml index 6013b1c3..4c04a0d7 100644 --- a/tools/src/test/resources/1.6/valid-machine-learning-1.6.xml +++ b/tools/src/test/resources/1.6/valid-machine-learning-1.6.xml @@ -61,15 +61,19 @@ Who are the intended users of the model? + Data scientists and ML researchers Who are the intended users of the model? + Text-to-image generation for creative applications What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance? + Limited performance on non-photographic styles What are the known tradeoffs in accuracy/performance of the model? + Higher resolution output requires more computational resources @@ -86,6 +90,10 @@ + + custom-value + another-custom-value + diff --git a/tools/src/test/resources/1.7/valid-machine-learning-1.7.json b/tools/src/test/resources/1.7/valid-machine-learning-1.7.json index cb64ee80..07674187 100644 --- a/tools/src/test/resources/1.7/valid-machine-learning-1.7.json +++ b/tools/src/test/resources/1.7/valid-machine-learning-1.7.json @@ -70,16 +70,20 @@ }, "considerations": { "users": [ - "Who are the intended users of the model?" + "Who are the intended users of the model?", + "Data scientists and ML researchers" ], "useCases": [ - "Who are the intended users of the model?" + "Who are the intended users of the model?", + "Text-to-image generation for creative applications" ], "technicalLimitations": [ - "What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?" + "What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?", + "Limited performance on non-photographic styles" ], "performanceTradeoffs": [ - "What are the known tradeoffs in accuracy/performance of the model?" + "What are the known tradeoffs in accuracy/performance of the model?", + "Higher resolution output requires more computational resources" ], "ethicalConsiderations": [ { @@ -95,7 +99,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" + } + ] } } ] diff --git a/tools/src/test/resources/1.7/valid-machine-learning-1.7.textproto b/tools/src/test/resources/1.7/valid-machine-learning-1.7.textproto index 25b78f5d..2f7c0b94 100644 --- a/tools/src/test/resources/1.7/valid-machine-learning-1.7.textproto +++ b/tools/src/test/resources/1.7/valid-machine-learning-1.7.textproto @@ -62,9 +62,13 @@ components: { } considerations: { users: "Who are the intended users of the model?" + users: "Data scientists and ML researchers" useCases: "Who are the intended users of the model?" + useCases: "Text-to-image generation for creative applications" technicalLimitations: "What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?" + technicalLimitations: "Limited performance on non-photographic styles" performanceTradeoffs: "What are the known tradeoffs in accuracy/performance of the model?" + performanceTradeoffs: "Higher resolution output requires more computational resources" ethicalConsiderations: { name: "The name of the risk" mitigationStrategy: "Strategy used to address this risk" @@ -76,5 +80,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" + } } } diff --git a/tools/src/test/resources/1.7/valid-machine-learning-1.7.xml b/tools/src/test/resources/1.7/valid-machine-learning-1.7.xml index 38df43ff..ba02fb8c 100644 --- a/tools/src/test/resources/1.7/valid-machine-learning-1.7.xml +++ b/tools/src/test/resources/1.7/valid-machine-learning-1.7.xml @@ -63,15 +63,19 @@ Who are the intended users of the model? + Data scientists and ML researchers Who are the intended users of the model? + Text-to-image generation for creative applications What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance? + Limited performance on non-photographic styles What are the known tradeoffs in accuracy/performance of the model? + Higher resolution output requires more computational resources @@ -88,6 +92,10 @@ + + custom-value + another-custom-value +