@grnsft/if 0.1.6 → 0.1.8

package/examples/impls/test/nesting.yml

@@ -1,62 +1,113 @@
 name: nesting-demo
-description:
+description: null
 tags:
   kind: web
   complexity: moderate
   category: on-premise
 initialize:
   models:
-    - name: teads-curve
-      model: TeadsCurveModel
-      path: "@grnsft/if-unofficial-models"
     - name: sci-e
+      path: '@grnsft/if-models'
       model: SciEModel
-      path: "@grnsft/if-models"
-    - name: sci-m
-      path: "@grnsft/if-models"
-      model: SciMModel
-    - name: sci-o
-      model: SciOModel
-      path: "@grnsft/if-models"
-    - name: sci
-      model: SciModel
-      path: "@grnsft/if-models"
 graph:
   children:
-    child: # an advanced grouping node
+    child-0:
       pipeline:
-        - teads-curve
         - sci-e
-        - sci-m
-        - sci-o
-        - sci
-      config:
-        teads-curve:
-          thermal-design-power: 65
-        sci-m:
-          total-embodied-emissions: 251000 # gCO2eq
-          time-reserved: 3600 # 1 hour in s
-          expected-lifespan: 126144000 # 4 years in seconds    
-          resources-reserved: 1 
-          total-resources: 1 
-        sci-o:
-          grid-carbon-intensity: 457 # gCO2/kwh
-        sci:
-          functional-unit-duration: 1 
-          functional-duration-time: ''
-          functional-unit: requests # factor to convert per time to per f.unit
       children:
-        child-1:
+        child-0-1:
+          pipeline:
+            - sci-e
+          config: null
           inputs:
             - timestamp: 2023-07-06T00:00
               duration: 10
               cpu-util: 50
-              e-net: 0.000811 #kwh     
-              requests: 380
-        child-2:
-          inputs: 
+              energy-network: 0.000811
+          outputs:
             - timestamp: 2023-07-06T00:00
               duration: 10
-              cpu-util: 33
-              e-net: 0.000811 #kwh     
-              requests: 380
+              cpu-util: 50
+              energy-network: 0.000811
+              energy: 0.000811
+        child-0-2:
+          children:
+            child-0-2-1:
+              pipeline:
+                - sci-e
+              config: null
+              inputs:
+                - timestamp: 2023-07-06T00:00
+                  duration: 10
+                  cpu-util: 50
+                  energy-network: 0.000811
+              outputs:
+                - timestamp: 2023-07-06T00:00
+                  duration: 10
+                  cpu-util: 50
+                  energy-network: 0.000811
+                  energy: 0.000811
+            child-0-2-2:
+              children:
+                child-1-2-1:
+                  pipeline:
+                    - sci-e
+                  config: null
+                  inputs:
+                    - timestamp: 2023-07-06T00:00
+                      duration: 10
+                      cpu-util: 50
+                      energy-network: 0.000811
+                  outputs:
+                    - timestamp: 2023-07-06T00:00
+                      duration: 10
+                      cpu-util: 50
+                      energy-network: 0.000811
+                      energy: 0.000811
+                child-1-2-2:
+                  children:
+                    child-1-2-2-1:
+                      pipeline:
+                        - sci-e
+                      config: null
+                      inputs:
+                        - timestamp: 2023-07-06T00:00
+                          duration: 10
+                          cpu-util: 50
+                          energy-network: 0.000811
+                      outputs:
+                        - timestamp: 2023-07-06T00:00
+                          duration: 10
+                          cpu-util: 50
+                          energy-network: 0.000811
+                          energy: 0.000811
+                    child-1-2-2-2:
+                      pipeline:
+                        - sci-e
+                      config: null
+                      inputs:
+                        - timestamp: 2023-07-06T00:00
+                          duration: 10
+                          cpu-util: 50
+                          energy-network: 0.000811
+                      outputs:
+                        - timestamp: 2023-07-06T00:00
+                          duration: 10
+                          cpu-util: 50
+                          energy-network: 0.000811
+                          energy: 0.000811
+                    child-1-2-2-3:
+                      pipeline:
+                        - sci-e
+                      config: null
+                      inputs:
+                        - timestamp: 2023-07-06T00:00
+                          duration: 10
+                          cpu-util: 50
+                          energy-network: 0.000811
+                      outputs:
+                        - timestamp: 2023-07-06T00:00
+                          duration: 10
+                          cpu-util: 50
+                          energy-network: 0.000811
+                          energy: 0.000811

package/examples/impls/test/sci.yml

@@ -3,7 +3,7 @@ description: example invoking sci model
 tags:
 initialize:
   models:
-    - name: sci 
+    - name: sci
       kind: plugin
       model: SciModel
       path: "@grnsft/if-models"
@@ -14,8 +14,8 @@ graph:
         - sci
       config:
         sci:
-          functional-unit-duration: 1 
-          functional-unit-time: 'minutes'
+          functional-unit-duration: 1
+          functional-unit-time: "1 minute"
           functional-unit: requests # factor to convert per time to per f.unit
       inputs:
         - timestamp: 2023-07-06T00:00

package/examples/impls/test/shell.yml

@@ -1,5 +1,5 @@
-name: ccf-demo
-description: example impl invoking CCF model
+name: shell-demo
+description: example impl invoking shell model
 tags:
 initialize:
   models:
@@ -13,7 +13,7 @@ graph:
         - sampler
       config:
         sampler:
-          executable: python3 /usr/local/bin/sampler
+          command: python3 /usr/local/bin/sampler
       inputs:
-          - timestamp: '2023-11-02T10:35:31.820Z'
-            duration: 3600
+        - timestamp: "2023-11-02T10:35:31.820Z"
+          duration: 3600

package/examples/ompls/nesting.yml

@@ -6,102 +6,108 @@ tags:
   category: on-premise
 initialize:
   models:
-    - name: teads-curve
-      kind: builtin
     - name: sci-e
-      kind: builtin
-      verbose: false
-      path: ''
-    - name: sci-m
-      kind: builtin
-      verbose: false
-      path: ''
-    - name: sci-o
-      kind: builtin
-      verbose: false
-      path: ''
-    - name: sci
-      kind: builtin
-      verbose: false
-      path: ''
+      path: '@grnsft/if-models'
+      model: SciEModel
 graph:
   children:
-    child:
+    child-0:
       pipeline:
-        - teads-curve
         - sci-e
-        - sci-m
-        - sci-o
-        - sci
-      config:
-        teads-curve:
-          thermal-design-power: 65
-        sci-m:
-          total-embodied-emissions: 251000
-          time-reserved: 3600
-          expected-lifespan: 126144000
-          resources-reserved: 1
-          total-resources: 1
-        sci-o:
-          grid-carbon-intensity: 457
-        sci:
-          functional-unit-duration: 1
-          functional-duration-time: ''
-          functional-unit: requests
       children:
-        child-1:
+        child-0-1:
+          pipeline:
+            - sci-e
+          config: null
           inputs:
             - timestamp: 2023-07-06T00:00
               duration: 10
               cpu-util: 50
-              e-net: 0.000811
-              requests: 380
+              energy-network: 0.000811
           outputs:
             - timestamp: 2023-07-06T00:00
               duration: 10
               cpu-util: 50
-              e-net: 0.000811
-              requests: 380
-              thermal-design-power: 65
-              total-embodied-emissions: 251000
-              time-reserved: 3600
-              expected-lifespan: 126144000
-              resources-reserved: 1
-              total-resources: 1
-              grid-carbon-intensity: 457
-              functional-unit-duration: 1
-              functional-duration-time: ''
-              functional-unit: requests
-              energy-cpu: 0.00013541666666666666
-              energy: 0.00013541666666666666
-              embodied-carbon: 7.16324200913242
-              operational-carbon: 0.061885416666666665
-              sci: 0.001901349322578707
-        child-2:
-          inputs:
-            - timestamp: 2023-07-06T00:00
-              duration: 10
-              cpu-util: 33
-              e-net: 0.000811
-              requests: 380
-          outputs:
-            - timestamp: 2023-07-06T00:00
-              duration: 10
-              cpu-util: 33
-              e-net: 0.000811
-              requests: 380
-              thermal-design-power: 65
-              total-embodied-emissions: 251000
-              time-reserved: 3600
-              expected-lifespan: 126144000
-              resources-reserved: 1
-              total-resources: 1
-              grid-carbon-intensity: 457
-              functional-unit-duration: 1
-              functional-duration-time: ''
-              functional-unit: requests
-              energy-cpu: 0.00011243956355860435
-              energy: 0.00011243956355860435
-              embodied-carbon: 7.16324200913242
-              operational-carbon: 0.05138488054628219
-              sci: 0.0018985860235996583
+              energy-network: 0.000811
+              energy: 0.000811
+        child-0-2:
+          children:
+            child-0-2-1:
+              pipeline:
+                - sci-e
+              config: null
+              inputs:
+                - timestamp: 2023-07-06T00:00
+                  duration: 10
+                  cpu-util: 50
+                  energy-network: 0.000811
+              outputs:
+                - timestamp: 2023-07-06T00:00
+                  duration: 10
+                  cpu-util: 50
+                  energy-network: 0.000811
+                  energy: 0.000811
+            child-0-2-2:
+              children:
+                child-1-2-1:
+                  pipeline:
+                    - sci-e
+                  config: null
+                  inputs:
+                    - timestamp: 2023-07-06T00:00
+                      duration: 10
+                      cpu-util: 50
+                      energy-network: 0.000811
+                  outputs:
+                    - timestamp: 2023-07-06T00:00
+                      duration: 10
+                      cpu-util: 50
+                      energy-network: 0.000811
+                      energy: 0.000811
+                child-1-2-2:
+                  children:
+                    child-1-2-2-1:
+                      pipeline:
+                        - sci-e
+                      config: null
+                      inputs:
+                        - timestamp: 2023-07-06T00:00
+                          duration: 10
+                          cpu-util: 50
+                          energy-network: 0.000811
+                      outputs:
+                        - timestamp: 2023-07-06T00:00
+                          duration: 10
+                          cpu-util: 50
+                          energy-network: 0.000811
+                          energy: 0.000811
+                    child-1-2-2-2:
+                      pipeline:
+                        - sci-e
+                      config: null
+                      inputs:
+                        - timestamp: 2023-07-06T00:00
+                          duration: 10
+                          cpu-util: 50
+                          energy-network: 0.000811
+                      outputs:
+                        - timestamp: 2023-07-06T00:00
+                          duration: 10
+                          cpu-util: 50
+                          energy-network: 0.000811
+                          energy: 0.000811
+                    child-1-2-2-3:
+                      pipeline:
+                        - sci-e
+                      config: null
+                      inputs:
+                        - timestamp: 2023-07-06T00:00
+                          duration: 10
+                          cpu-util: 50
+                          energy-network: 0.000811
+                      outputs:
+                        - timestamp: 2023-07-06T00:00
+                          duration: 10
+                          cpu-util: 50
+                          energy-network: 0.000811
+                          energy: 0.000811

package/examples/ompls/sci.yml

@@ -5,7 +5,7 @@ initialize:
   models:
     - name: sci
       kind: builtin
-      path: ''
+      path: ""
 graph:
   children:
     child:
@@ -14,7 +14,7 @@ graph:
       config:
         sci:
           functional-unit-duration: 1
-          functional-unit-time: minutes
+          functional-unit-time: "1 minute"
           functional-unit: requests
       inputs:
         - timestamp: 2023-07-06T00:00
@@ -31,6 +31,7 @@ graph:
           embodied-carbon: 0.02
           requests: 100
           functional-unit-duration: 1
-          functional-unit-time: minutes
+          functional-unit-time: "1 minute"
           functional-unit: requests
+          carbon: 0.0013944444444444442
           sci: 0.0008366666666666665

package/examples/ompls/shell.yml

@@ -1,5 +1,5 @@
-name: ccf-demo
-description: example impl invoking CCF model
+name: shell-demo
+description: example impl invoking shell model
 tags: null
 initialize:
   models:
@@ -12,12 +12,12 @@ graph:
         - sampler
       config:
         sampler:
-          executable: python3 /usr/local/bin/sampler
+          command: python3 /usr/local/bin/sampler
       inputs:
-        - timestamp: '2023-11-02T10:35:31.820Z'
+        - timestamp: "2023-11-02T10:35:31.820Z"
           duration: 3600
       outputs:
-        - duration: 3600
+        - timestamp: "2023-11-02T10:35:31.820Z"
+          duration: 3600
           energy: 1
-          executable: python3 /usr/local/bin/sampler
-          timestamp: '2023-11-02T10:35:31.820Z'
+          

package/grafana/IF_GRAFANA_SETUP.md

@@ -0,0 +1,71 @@
+# Setting up the Impact Framework Grafana dashboard
+(for any questions please contact paz.barda@intel.com / pazbarda@gmail.com)
+
+## Download and Install Grafana
+https://grafana.com/get/?plcmt=top-nav&cta=downloads&tab=self-managed
+
+This is the self managed version: you install it and can run it on your local machine. 
+
+## Open Grafana on your local machine
+Web browser: localhost:3000
+
+You should see the Grafana welcome page.
+
+## Download and Install Grafana CSV plugin
+https://grafana.com/grafana/plugins/marcusolsson-csv-datasource/?tab=installation
+
+After installation, go to Menu -> Plugins, search for "CSV" and make sure CSV plugin is there
+
+## Import the dashboard json config
+
+Menu -> Dashboards -> New -> Import
+
+1. Drag and drop "grafana_config.json" from this folder to Grafana webpage
+2. Optional - change the name of the dashboard and the details text on the right
+3. Click import.
+
+Dashboard should now appear, but with no data fed into the charts (yet).
+
+## Create a data source for your OMPL CSV file
+Menu -> Connections -> Data Sources -> Add data source
+
+1. Search for "CSV", you should see the CSV plugin. Click it.
+2. Name you new data source.
+3. Switch from "HTTP" to "Local".
+4. Type/paste in the path to your ompl csv ("your/path/to/csvs/if-iee-demo.csv" in our example)
+
+Click Save & Test
+
+
+
+## Connect your OMPL CSV data source to your dashboard
+
+Menu -> Dashboards -> Select your new dashboard 
+
+For each blank chart:
+
+1. Click the chart menu -> edit
+2. Below the chart go to Quary tab
+3. At the top of the tab select the ompl CSV datasource you created
+4. Go to Transform tab, and select the fields you'd like to show on the chart.
+5. Start with "timestamp" and convert it to "Time".
+6. Any other numeric value you'd like to show should be converted to "Number"
+
+Click Apply
+
+Click Save
+
+NOTE: when you select a CSV file (step 3) it might initially not show the columns in the transformation dropdown. if that happens - save the dashboard, exit it refresh the Grafana webpage (localhost:3000). Once you go into the dashboard again it should show the columns for transformation. 
+
+
+## Enable auto-refresh of the dashboard
+
+On the top right of the dashboard, look for the "refresh dashboard" button
+
+Click the dropdown next to it, and choose the auto-refresh interval
+
+Click Save
+
+## Your dashboard is now ready to go!
+With every change to you CSV file you should see it reflect on the dashboard momentarily.
+