Skip to content

Hardware

a hardware subsystem part of the infrastructure running the computing task
componentName(string)

the name of this subsystem part of your infrastructure, example returned by codecarbon: 1 x NVIDIA GeForce GTX 1080 Ti

Type: string
Required: False

componentType(string)

the type of this subsystem part of your infrastructure, example: cpu, gpu, ram, hdd, sdd...

Type: string
Required: True

nbComponent(integer)

the number of items of this component in your infrastructure, if you have 1 RAM of 32Go, fill 1 here and 32 inside memorySize

Type: integer
Required: True

memorySize(number)

the size of the memory of the component in Gbytes, useful to detail the memory associated to ONE of your gpus for example (if we want the total memory, we will multiply the memorySize by nbComponent). If the component is CPU do not fill the RAM size here, create another component for RAM, this field is for the embeded memory of a component.

Type: number
Required: False

manufacturer(string)

the name of the manufacturer, example: nvidia

Type: string
Required: False

family(string)

the family of this component, example: geforce

Type: string
Required: False

series(string)

the series of this component, example: gtx1080

Type: string
Required: False

share(number)

the percentage of the physical equipment used by the task, this sharing property should be set to 1 by default (if no share) and otherwise to the correct percentage, e.g. 0.5 if you share half-time.

Type: number
Required: False