create mkdocs

genai-impact · Mar 1, 2024 · bfb657b · bfb657b
1 parent c27e82c
commit bfb657b
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/docs/assets/logo.png b/docs/assets/logo.png
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,23 @@
+# Welcome to GenAI Impact
+
+GenAI Impact is an open-source project built by [Data For Good](https://dataforgood.fr/) to highlight GenAI tools' energy consumption.
+
+## Installation
+
+    pip install genai_impact
+
+
+## Basic example for OpenAI
+
+    from genai_impact.client_wrapper import OpenAI
+
+    client = OpenAI()
+
+    response = client.chat.completions.create(
+        model="gpt-3.5-turbo",
+        messages=[
+            {"role": "user", "content": "Hello World!"}
+        ]
+    )
+
+    print(response.impacts)