Skip to content

Report

the main object containing all the context pretaining to a computing task
header(object)

information about the source of the report and publishing organization's details 

Type: object
Required: False

licensing(string)

the type of licensing applicable for the sharing of the report 

Type: string
Required: False

formatVersion(string)

the version of the specification of this set of schemas defining the report's fields 

Type: string
Required: False

formatVersionSpecificationUri(string)

the URI of the present specification of this set of schemas 

Type: string
Required: False

reportId(string)

the unique identifier of this report, preferably as a uuid4 string 

Type: string
Required: False

reportDatetime(string)

the publishing date of this report in format YYYY-MM-DD HH:MM:SS 

Type: string
Required: True

reportStatus(string)

the status of this report 

Type: string
Required: False
Valid Values:
"draft"
"final"
"corrective"
"other"

publisher(object)

the details about the publishing organization who produced the report 

Type: object
Required: False

name(string)

name of the organization 

Type: string
Required: False

division(string)

name of the publishing department within the organization 

Type: string
Required: False

projectName(string)

name of the publishing project within the organization 

Type: string
Required: False

confidentialityLevel(string)

the confidentiality of the report 

Type: string
Required: True
Valid Values:
"public"
"internal"
"confidential"
"secret"

publicKey(string)

the cryptographic public key to check the identity of the publishing organization 

Type: string
Required: False

task(object)

the nature of the task being measured 

Type: object
Required: True

taskStage(string)

stage of the task, example: datacreation, preprocessing, training, finetuning, inference, retraining..., add a + between stages if several but we do recommand to measure each step independantly 

Type: string
Required: True

taskFamily(string)

the family of task you are running, e.g. text classification, image generation, speech recognition, robotics navigation... 

Type: string
Required: True

nbRequest(number)

if inference stage, the number of requests the measure corresponds to, 0 or empty if you're not measuring the inference stage 

Type: number
Required: False

algorithms(array)

the list of the main algorithmic approache(s) used by the computing task 

Type: array
Required: True

items(object)

items 

Type: object
Required: False

dataset(array)

the list of dataset processed and/or generated by the computing task, if you are working on multipodal training you can add many items to the list to describe it. If you are working on inference, you can add at least one item to describe the input data and another one for the output 

Type: array
Required: True

items(object)

items 

Type: object
Required: False

measuredAccuracy(number)

the measured accuracy of your model (between 0 and 1) 

Type: number
Required: False

estimatedAccuracy(string)

if you didn't measure the accuracy of your model in concrete percentages, you can give an assessment of the precision between: VERY POOR, POOR, AVERAGE, GOOD, VERY GOOD 

Type: string
Required: False
Valid Values:
"veryPoor"
"poor"
"average"
"good"
"veryGood"

taskDescription(string)

free field, to be fillied in if you have more details to share about your task 

Type: string
Required: False

measures(array)

the software and/or hardware measures of the energy consumed by the computing task 

Type: array
Required: True

items(object)

items 

Type: object
Required: False

system(object)

system information of the infrastructure on which is run the computing task 

Type: object
Required: False

os(string)

name of the operating system 

Type: string
Required: True

distribution(string)

distribution of the operating system 

Type: string
Required: False

distributionVersion(string)

distribution's version of the operating system 

Type: string
Required: False

software(object)

programming language information of the computing task 

Type: object
Required: False

language(string)

name of the programming language used, example : c, java, julia, python... 

Type: string
Required: True

version(string)

version of the programming language used 

Type: string
Required: False

infrastructure(object)

the infrastructure on which is performed the computing task 

Type: object
Required: True

infraType(string)

the type of infrastructure used for the task 

Type: string
Required: True
Valid Values:
"publicCloud"
"privateCloud"
"onPremise"
"other"

cloudProvider(string)

If you are on the cloud, the name of your cloud provider, for example : aws, azure, google, ovh... 

Type: string
Required: False

cloudInstance(string)

If you are on a cloud vm, the name of your cloud instance, for example : a1.large, dasv4-type2... 

Type: string
Required: False

cloudService(string)

If you are using an AI cloud service, the name of your cloud service, for example : openAI service... 

Type: string
Required: False

components(array)

components 

Type: array
Required: True

items(object)

items 

Type: object
Required: False

environment(object)

environment of the infrastructure: region of calculation and energy used 

Type: object
Required: False

country(string)

country 

Type: string
Required: True

latitude(number)

latitude 

Type: number
Required: False

longitude(number)

longitude 

Type: number
Required: False

location(string)

more precise location like city, region or datacenter name 

Type: string
Required: False

powerSupplierType(string)

powerSupplierType 

Type: string
Required: False
Valid Values:
"public"
"private"
"internal"
"other"

powerSource(string)

powerSource 

Type: string
Required: False
Valid Values:
"solar"
"wind"
"nuclear"
"hydroelectric"
"gas"
"coal"
"other"

powerSourceCarbonIntensity(number)

carbon intensity of the electicity you used (in gCO2eq/kWh) 

Type: number
Required: False

quality(string)

the quality of the information you provided, 3 possibilities : high (percentage error +/-10%), medium (percentage error +/-25%), low (percentage error +/-50%) 

Type: string
Required: False
Valid Values:
"high"
"medium"
"low"