Update README.md

README.md

@@ -83,3 +83,16 @@ configs:
   - split: benchmark_results
     path: data/train-*
 ---
+
+# Analysis of energy usage for HUGS models
+
+Based on the [energy_star branch](https://github.com/huggingface/optimum-benchmark/tree/energy_star_dev) of [optimum-benchmark](https://github.com/huggingface/optimum-benchmark), and using [codecarbon](https://pypi.org/project/codecarbon/2.1.4/).
+
+# Fields
+- task: Task the model was benchmarked on
+- org: Organization hosting the model
+- model: The specific model. Model names at HF are usually constructed with {org}/{model}
+- date: The date that the benchmark was fun
+- prefill: The esimated energy and efficiency for prefilling.
+- decode: The estimated energy and efficiency for decoding.
+- preprocess: The estimated energy and efficiency for preprocessing.