cdx-proto
    Preparing search index...

    Type Alias ModelCard

    ModelCard: Message<"cyclonedx.v1_7.ModelCard"> & {
        bomRef?: string;
        considerations?: ModelCard_ModelCardConsiderations;
        modelParameters?: ModelCard_ModelParameters;
        quantitativeAnalysis?: ModelCard_QuantitativeAnalysis;
    }

    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.

    Comment: Model card support in CycloneDX is derived from TensorFlow Model Card Toolkit released under the Apache 2.0 license and available from https://github.com/tensorflow/model-card-toolkit/blob/main/model_card_toolkit/schema/v0.0.2/model_card.schema.json. In addition, CycloneDX model card support includes portions of VerifyML, also released under the Apache 2.0 license and available from https://github.com/cylynx/verifyml/blob/main/verifyml/model_card_toolkit/schema/v0.0.4/model_card.schema.json.

    Type Declaration

    • OptionalbomRef?: string

      A identifier which can be used to reference the model card elsewhere in the BOM. Every bom_ref must be unique within the BOM.

      from field: optional string bom_ref = 1;

    • Optionalconsiderations?: ModelCard_ModelCardConsiderations

      What considerations should be taken into account regarding the model's construction, training, and application?

      from field: optional cyclonedx.v1_7.ModelCard.ModelCardConsiderations considerations = 4;

    • OptionalmodelParameters?: ModelCard_ModelParameters

      Hyper-parameters for construction of the model.

      from field: optional cyclonedx.v1_7.ModelCard.ModelParameters modelParameters = 2;

    • OptionalquantitativeAnalysis?: ModelCard_QuantitativeAnalysis

      A quantitative analysis of the model

      from field: optional cyclonedx.v1_7.ModelCard.QuantitativeAnalysis quantitativeAnalysis = 3;

    from message cyclonedx.v1_7.ModelCard

    Settings

    Member Visibility