spdx / spdx-3-model

The model for the information captured in SPDX version 3 standard.
https://spdx.dev/use/specifications/
Other
69 stars 44 forks source link

AI: Not clear what 'energyQuantity' means #767

Closed VenkatTechnologist closed 2 months ago

VenkatTechnologist commented 4 months ago

The property energyQuantity's name or its description does not provide enough information to understand what the property stands for.

bact commented 4 months ago

Thanks @VenkatTechnologist, will this be something sufficient ?

            "ai_energyConsumption": {
                "type": "ai_EnergyConsumption",
                "ai_trainingEnergyConsumption": {
                    "type": "ai_EnergyConsumptionDescription",
                    "ai_energyQuantity": 36.5,
                    "ai_energyUnit": "kilowattHour"
                },
                "ai_inferenceEnergyConsumption": {
                    "type": "ai_EnergyConsumptionDescription",
                    "ai_energyQuantity": 0.0042,
                    "ai_energyUnit": "kilowattHour"
                }
            },

We are now working on examples. If you find there's anything need more explanation, feel free to shout out. Thank you.

VenkatTechnologist commented 4 months ago

In addition to the examples, it would be good to provide explanation of what energyQuantity is, and how it fits in the scheme of EnergyConsumption(s).

The reason for the confusion is because we have two similar sounding objects EnergyConsumption and energyQuantity without the details of how they are placed. Thanks.

On Mon, May 20, 2024 at 4:21 PM Arthit Suriyawongkul < @.***> wrote:

Thanks @VenkatTechnologist https://github.com/VenkatTechnologist, will this be something sufficient ?

{ "energyConsumption": { "trainingEnergyConsumption": { "energyQuantity": 345, "energyUnit": "kilowattHour" }, "finetuningEnergyConsumption": { "energyQuantity": 42, "energyUnit": "kilowattHour" } } }

We are now working on examples. If you find there's anything need more explanation, feel free to shout out. Thank you.

— Reply to this email directly, view it on GitHub https://github.com/spdx/spdx-3-model/issues/767#issuecomment-2120195270, or unsubscribe https://github.com/notifications/unsubscribe-auth/BFJ5PIK4S4QX6TEK7AC7AMLZDHIR3AVCNFSM6AAAAABHOS63SWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMRQGE4TKMRXGA . You are receiving this because you were mentioned.Message ID: @.***>

bact commented 4 months ago

Thanks. Will this read better?

Represents the energy quantity.

The quantity is the amount or numerical value of the energy we are trying to represent.
The unit of measure is how we express the measurement of the quantity.

For example, 42 kilowatt-hour of energy will have the property `energyQuantity` as
`42` and the property `energyUnit` as `kilowattHour`.

The 2nd and 3rd paragraphs will also be added to energyUnit description.

VenkatTechnologist commented 4 months ago

Here is a more concise description:

"energyQuantity represents the numerical value of energy consumed, and energyUnit is the measurement unit for the energy consumed.

For example, 42 kilowatt-hour of energy will have 42 as value for property energyQuantity, and kilowattHour as value for property energyUnit."

Thanks,

Venkat.

On Mon, May 20, 2024 at 9:46 PM Arthit Suriyawongkul < @.***> wrote:

Thanks. Will this read better?

"Represents the energy quantity.

The quantity is the amount or numerical value of the energy we are trying to represent. The unit of measure is how we express the measurement of the quantity.

For example, 42 kilowatt-hour of energy will have the property energyQuantity as 42 and the property energyUnit as kilowattHour."

The 2nd and 3rd paragraphs will also be added to energyUnit description.

— Reply to this email directly, view it on GitHub https://github.com/spdx/spdx-3-model/issues/767#issuecomment-2120772688, or unsubscribe https://github.com/notifications/unsubscribe-auth/BFJ5PIOY647YK5ZPLZEWBXTZDIOXFAVCNFSM6AAAAABHOS63SWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMRQG43TENRYHA . You are receiving this because you were mentioned.Message ID: @.***>

bact commented 3 months ago

Code snippet and narrated example are add to EnergyConsumption and EnergyConsumptionDescription, in PR #780