https://github.com/genai-impact/ecologits

🌱 EcoLogits tracks the energy consumption and environmental footprint of using generative AI models through APIs.
https://github.com/genai-impact/ecologits

genai generative-ai green-ai green-software llm llm-inference python sustainability sustainable-ai

Last synced: 6 days ago
JSON representation

🌱 EcoLogits tracks the energy consumption and environmental footprint of using generative AI models through APIs.

• Host: GitHub
• URL: https://github.com/genai-impact/ecologits
• Owner: genai-impact
• License: mpl-2.0
• Created: 2024-02-02T16:25:32.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-10-28T16:01:42.000Z (11 days ago)
• Last Synced: 2024-10-30T03:37:59.802Z (9 days ago)
• Topics: genai, generative-ai, green-ai, green-software, llm, llm-inference, python, sustainability, sustainable-ai
• Language: Python
• Homepage: https://ecologits.ai/
• Size: 3.84 MB
• Stars: 80
• Watchers: 9
• Forks: 8
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: LICENSE
  • Roadmap: docs/roadmap.md

Awesome Lists containing this project

• awesome-green-ai - EcoLogits - black?style=flat&logo=linux)    (🛠 Tools / Code-Based Tools)
• open-sustainable-technology - EcoLogits - Tracks the energy consumption and environmental impacts of using generative AI models through APIs. (Consumption / Computation and Communication)
• green-ai - [Source code

README

        


  

    

    

  



🌱 **EcoLogits** tracks the energy consumption and environmental impacts of using generative AI models through APIs.

[![PyPI version](https://img.shields.io/pypi/v/ecologits?color=00bf63)](https://pypi.org/project/ecologits/)

[![Python version](https://img.shields.io/pypi/pyversions/ecologits)](https://pypi.org/project/ecologits/)

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1VxrpJ5xuWZKQLsSN12kdqUqkppHRct3G?usp=sharing)

**Documentation: [ecologits.ai](https://ecologits.ai/)**

## ⚙️ Installation

```shell

pip install ecologits

```

For integration with a specific provider, use `pip install ecologits[openai]`. We are currently supporting the following providers: `anthropic`, `cohere`, `google-generativeai`, `huggingface-hub`, `mistralai` and `openai`. See the full [list of providers](https://ecologits.ai/latest/tutorial/providers/).

## 🚀 Usage

```python

from ecologits import EcoLogits

from openai import OpenAI

# Initialize EcoLogits

EcoLogits.init()

client = OpenAI(api_key="")

response = client.chat.completions.create(

    model="gpt-3.5-turbo",

    messages=[

        {"role": "user", "content": "Tell me a funny joke!"}

    ]

)

# Get estimated environmental impacts of the inference

print(f"Energy consumption: {response.impacts.energy.value} kWh")

print(f"GHG emissions: {response.impacts.gwp.value} kgCO2eq")

```

See package documentation on [EcoLogits](https://ecologits.ai/)

## 💪 Contributing

To get started with setting up a development environment and making a contribution to EcoLogits, see [Contributing to EcoLogits](https://ecologits.ai/latest/contributing/).

## ⚖️ License

This project is licensed under the terms of the [Mozilla Public License Version 2.0 (MPL-2.0)](https://www.mozilla.org/en-US/MPL/2.0/).