Class ModelCard_ModelCardConsiderations

Generated

from message cyclonedx.v1_5.ModelCard.ModelCardConsiderations

Hierarchy

Constructors

Properties

What are the ethical (or environmental) risks involved in the application of this model?

Generated

from field: repeated cyclonedx.v1_5.ModelCard.ModelCardConsiderations.EthicalConsiderations ethicalConsiderations = 5;

How does the model affect groups at risk of being systematically disadvantaged? What are the harms and benefits to the various affected groups?

Generated

from field: repeated cyclonedx.v1_5.ModelCard.ModelCardConsiderations.FairnessAssessments fairnessAssessments = 6;

performanceTradeoffs: string[] = []

What are the known tradeoffs in accuracy/performance of the model?

Generated

from field: repeated string performanceTradeoffs = 4;

technicalLimitations: string[] = []

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?

Generated

from field: repeated string technicalLimitations = 3;

useCases: string[] = []

What are the intended use cases of the model?

Generated

from field: repeated string useCases = 2;

users: string[] = []

Who are the intended users of the model?

Generated

from field: repeated string users = 1;

fields: FieldList = ...
runtime: ProtoRuntime = proto3
typeName: "cyclonedx.v1_5.ModelCard.ModelCardConsiderations" = "cyclonedx.v1_5.ModelCard.ModelCardConsiderations"

Methods

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns this

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns this

  • Serialize the message to binary data.

    Parameters

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string