README.md

TDP Finder Plugin

Scope

The TDP Finder model finds the thermal design power (TDP) of a given processor by looking it up in the model datasets. There are scenarios where the lookup can return multiple possible TDP values. In these cases, we return the maximum of the possible values. There are also cases where no TDP can be found for a specific processor. In these cases, we throw an error. The TDP is then used by other plugins to calculate the cpu/energy value.

Used DataSets

./data.csv Dataset from https://www.kaggle.com/datasets/lincolnzh/cpu-specifications-dataset Licensed under CC BY-NC-SA 4.0

./data2.csv Dataset from Codecarbon Licensed under MIT

./boavizta_data.csv Dataset from Boavizta API Data Source Licensed under MIT

Implementation

To run the plugin, you must first create an instance of TdpFinder. Then, you can call execute().

import {TdpFinder} from '@grnsft/if-plugins';

const tdpFinder = TdpFinder();
const result = await tdpFinder.execute([
  {
    timestamp: '2023-11-02T10:35:31.820Z',
    duration: 3600,
    'physical-processor': 'AMD 3020e',
  },
]);

Example manifest

IF users will typically call the plugin as part of a pipeline defined in a manifest file. In this case, instantiating the plugin is handled by and does not have to be done explicitly by the user. The following is an example manifest that calls tpd-finder:

name: tdp-demo
description:
tags:
initialize:
  outputs:
    - yaml
  plugins:
    finder:
      method: TdpFinder
      path: '@grnsft/if-plugins'
tree:
  children:
    child:
      pipeline:
        - finder
      inputs:
        - physical-processor: Intel Xeon Platinum 8175M, AMD A8-9600

Output in output

name: tdp-demo
description:
tags:
initialize:
  outputs:
    - yaml
  plugins:
    finder:
      method: TdpFinder
      path: '@grnsft/if-plugins'
tree:
  children:
    child:
      pipeline:
        - finder
      inputs:
        - physical-processor: Intel Xeon Platinum 8175M, AMD A8-9600
      outputs:
        - physical-processor: Intel Xeon Platinum 8175M, AMD A8-9600
          cpu/thermal-design-power: 150

You can run this example manifest by saving it as ./examples/manifests/test/tdp-finder.yml and executing the following command from the project root:

npm i -g @grnsft/if
npm i -g @grnsft/if-plugins
ie --manifest ./examples/manifests/test/tdp-finder.yml --output ./examples/outputs/tdp-finder.yml

The results will be saved to a new yaml file in ./examples/outputs.