Class ModelCard_ModelCardConsiderations_EnergyConsumption

Describes energy consumption information incurred for the specified lifecycle activity.

Generated

from message cyclonedx.v1_6.ModelCard.ModelCardConsiderations.EnergyConsumption

Hierarchy

Constructors

Properties

activity: ModelCard_ModelCardConsiderations_EnergyConsumption_ActivityType = ModelCard_ModelCardConsiderations_EnergyConsumption_ActivityType.UNSPECIFIED

The type of activity that is part of a machine learning model development or operational lifecycle.

Generated

from field: cyclonedx.v1_6.ModelCard.ModelCardConsiderations.EnergyConsumption.ActivityType activity = 1;

activityEnergyCost?: EnergyMeasureType

The total energy cost associated with the model lifecycle activity.

Generated

from field: cyclonedx.v1_6.EnergyMeasureType activityEnergyCost = 3;

co2CostEquivalent?: CO2MeasureType

The CO2 cost or debit equivalent to the total energy cost.

Generated

from field: optional cyclonedx.v1_6.CO2MeasureType co2CostEquivalent = 4;

co2CostOffset?: CO2MeasureType

The CO2 offset or credit for the CO2 equivalent cost.

Generated

from field: optional cyclonedx.v1_6.CO2MeasureType co2CostOffset = 5;

energyProviders: EnergyProviderType[] = []

The providers of the energy consumed by the associated model development lifecycle activity.

Generated

from field: repeated cyclonedx.v1_6.EnergyProviderType energyProviders = 2;

properties: cdx_16.Property[] = []

Specifies optional, custom properties for environment considerations

Generated

from field: repeated cyclonedx.v1_6.Property properties = 6;

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

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