tutorial to upload boamps data

README.md

@@ -1,3 +1,43 @@
 ---
 license: apache-2.0
 ---
+
+# Guide: How to share your data on the BoAmps repository
+
+This guide explains step by step how to share BoAmps format reports on this public Hugging Face repository. 
+
+## Table of Contents
+- [Guide: How to share your data on the BoAmps repository](#guide-how-to-share-your-data-on-the-boamps-repository)
+  - [Table of Contents](#table-of-contents)
+  - [Prerequisites](#prerequisites)
+  - [Method 1: Hugging Face Web Interface](#method-1-hugging-face-web-interface)
+  - [Method 2: Git (Command Line)](#method-2-git-command-line)
+
+## Prerequisites
+
+Before starting, make sure you have:
+- A Hugging Face account
+- The files you want to upload
+
+## Method 1: Hugging Face Web Interface
+
+1. Log in to Hugging Face
+2. Go to [the boamps dataset](https://huggingface.co/datasets/boavizta/open_data_boamps)
+3. Navigate to the files: Click on "Files and versions" then on the "data" folder
+![Access to files](screenshots/01-access-repository.png)
+![Access to data folder](screenshots/02-access-data-files.png)
+4. Click on "Contribute" then "Upload files"
+![Contribute](screenshots/03-upload-files.png) 
+
+5. Drop your files in BoAmps format (please name them clearly) and give a name to the PR (e.g. 10 reports on image classification). You can add an extended description but this is optional.
+6. At the bottom of the page, click on "Open a Pull Request".
+7. You should see your PR created in "Community" > "Pull request". Now just wait for our team to validate your PR, thank you very much for your participation and your commitment to more frugal AI, in full transparency!
+![Consult](screenshots/04-consult-pr.png) 
+
+
+## Method 2: Git (Command Line)
+
+1. Clone the repository
+2. Create a branch
+3. Add your files
+4. Create a PR 

data/energy-report-llm-inference-&.json

@@ -0,0 +1,91 @@
+{
+  "header": {
+    "licensing": "Creative Commons 4.0",
+    "formatVersion": "0.1",
+    "reportId": "2f4643f7-68b5-4fb6-21f0-b5dcda04897d",
+    "reportDatetime": "2025-02-26 16:57:00",
+    "reportStatus": "draft",
+    "publisher": {
+      "name": "sopra steria",
+      "confidentialityLevel": "public"
+    }
+  },
+  "task": {
+    "taskStage": "inference",
+    "taskFamily": "chatbot",
+    "nbRequest": 1,
+    "algorithms": [
+      {
+        "algorithmType": "llm",
+        "foundationModelName": "llama2-13b",
+        "foundationModelUri": "https://huggingface.co/meta-llama/Llama-2-13b-hf",
+        "framework": "vllm",
+        "parametersNumber": 13,
+        "quantization": "q16"
+      }
+    ],
+    "dataset": [
+      {
+        "dataUsage": "input",
+        "dataType": "token",
+        "dataQuantity": 11
+      },
+      {
+        "dataUsage": "output",
+        "dataType": "token",
+        "dataQuantity": 828
+      }
+    ],
+    "estimatedAccuracy": "veryGood"
+  },
+  "measures": [
+    {
+      "measurementMethod": "codecarbon",
+      "version": "2.5.0",
+      "cpuTrackingMode": "constant",
+      "gpuTrackingMode": "nvml",
+      "powerConsumption": 0.00267074,
+      "measurementDuration": 19.09390426,
+      "measurementDateTime": "2024-09-30 09:09:40"
+    }
+  ],
+  "system": {
+    "os": "linux"
+  },
+  "software": {
+    "language": "python",
+    "version": "3.10.12"
+  },
+  "infrastructure": {
+    "infraType": "publicCloud",
+    "cloudProvider": "ovh",
+    "components": [
+      {
+        "componentName": "Intel(R) Xeon(R) Gold 6226R CPU @ 2.90GHz",
+        "componentType": "cpu",
+        "nbComponent": 30,
+        "manufacturer": "Intel",
+        "family": "Xeon",
+        "series": "Gold 6226R"
+      },
+      {
+        "componentName": "2 x Tesla V100S-PCIE-32GB",
+        "componentType": "gpu",
+        "nbComponent": 2,
+        "memorySize": 32,
+        "manufacturer": "Tesla",
+        "family": "V100"
+      },
+      {
+        "componentType": "ram",
+        "nbComponent": 1,
+        "memorySize": 86
+      }
+    ]
+  },
+  "environment": {
+    "country": "france",
+    "powerSupplierType": "public"
+  },
+  "quality": "high"
+}