Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Signed-off-by: Joseph Cook <33655003+jmcook1186@users.noreply.github.com>
  • Loading branch information
jmcook1186 authored Oct 24, 2023
1 parent e37511d commit 1d5a3fe
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
6 changes: 3 additions & 3 deletions docs/How to write impls.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ abstract: Guidance for writing valid impls.
# IMPL writing guide

The Impact Framework receives all its configuration and observation data in the form of a `yaml` file known as an `impl` (input-yaml).
To use the framework, a user only has to write an `impl` file and pass its path to the command line tool. This guide will help you to understand how to construct an `impl` you can use to measure the energy and carbon usage of your app.
To use the framework, a user only has to write an `impl` file and pass its path to the command line tool. This guide will help you to understand how to construct an `impl` and use it to measure the energy and carbon usage of your app.

## Structure of an `impl`

Expand Down Expand Up @@ -222,13 +222,13 @@ graph:
```

You can combine complex model pipelines and compelx application architectures to calculate the energy and carbon impacts of complicated systems!
You can combine complex model pipelines and complex application architectures to calculate the energy and carbon impacts of complicated systems!

## Choosing which models to run

The models are designed to be composable, but they each have specific input requirements that must be met in order for the models to run correctly. For example, teh `teads-curve` model requires `tdp` to be available in the `impl`. If it is not there, the model cannot use it to calculate `e-cpu`. You can refer to the [individual model documentation](../docs/implementations/Readme.md) to see the parameters and return values for each model.

it is also possible to leapfrog some models if you have access to high-level data. For exampel, perhaps you already know the energy being used by your CPU. In this case, there is no need to run `teads-curve`, you can simply provide `e-cpu` as an `observation` and omit `teads-curve` from the model pipeline.
it is also possible to leapfrog some models if you have access to high-level data. For example, perhaps you already know the energy being used by your CPU. In this case, there is no need to run `teads-curve`, you can simply provide `e-cpu` as an `observation` and omit `teads-curve` from the model pipeline.

We have deliberately made the models modular and composable so that you can be creative in developing new plugins to replace those provided as part of IEF.

Expand Down
3 changes: 2 additions & 1 deletion examples/impls/test/full-sci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,5 @@ graph:
- timestamp: 2023-07-06T00:00
duration: 1
cpu-util: 55
requests: 100
requests: 100

3 changes: 2 additions & 1 deletion examples/impls/test/nesting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,5 @@ graph:
duration: 10
cpu-util: 33
e-net: 0.000811 #kwh
requests: 380
requests: 380

1 change: 0 additions & 1 deletion src/__tests__/integration/ompl/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ describe('ompls: ', () => {
*/
files.forEach(file => {
if (file.includes('nesting')) {
console.log(file);
it('check nested ompls have impacts field', async () => {
expect.assertions(2);
const ompl = await openYamlFileAsObject(path + '/' + file);
Expand Down

0 comments on commit 1d5a3fe

Please sign in to comment.