diff --git a/docs/assets/logo.png b/docs/assets/logo.png new file mode 100644 index 0000000..4e2af00 Binary files /dev/null and b/docs/assets/logo.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..63064b0 --- /dev/null +++ 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)