Skip to main content

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

Project description

EcoLogits

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

PyPI version Python version Open In Colab

Documentation: ecologits.ai

⚙️ Installation

pip install ecologits

For integration with a specific provider, use pip install ecologits[openai]. We are currently supporting the following providers: anthropic, cohere, huggingface-hub, mistralai and openai. See the full list of providers.

🚀 Usage

from ecologits import EcoLogits
from openai import OpenAI

# Initialize EcoLogits
EcoLogits.init()

client = OpenAI(api_key="<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

💪 Contributing

Requirements

Have poetry installed on your system.

Easy install using a virtualenv:

Create a venv:

python3 -m venv .venv
source .venv/bin/activate

Install poetry:

pip install poetry

Install project

poetry install --all-extras --with dev,docs

Run tests

poetry run pytest

Run pre-commit hooks locally

Install pre-commit

pre-commit run --all-files

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ecologits-0.1.7.tar.gz (20.0 kB view hashes)

Uploaded Source

Built Distribution

ecologits-0.1.7-py3-none-any.whl (24.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page