mlco2/ecologits

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

EcoLogits – 估算生成式 AI 调用的碳影响

它是什么 – EcoLogits 是一个 Python 库，测量对流行生成式 AI API（OpenAI、Anthropic、Cohere、Google‑GenAI、HuggingFace、Mistral AI 等）的推理请求所使用的能源与温室气体排放。它直接嵌入客户端代码，照常发送请求，并返回包含估算 kWh 与 CO₂‑当量值的 impacts 对象。

为何重要 – 随着大型语言模型变得无处不在，其计算足迹也持续增长。EcoLogits 为开发者提供简单方式揭露这隐藏成本，帮助团队做出更可持续的选择、报告排放或抵消使用量。

安装

pip install ecologits                # 核心包
pip install ecologits[openai]        # 为特定 provider 添加支持（例如 OpenAI）

支持的 provider 列在文档中，包括 anthropic、cohere、google-genai、huggingface-hub、mistralai 与 openai。

基本用法

from ecologits import EcoLogits
from openai import OpenAI

EcoLogits.init(providers=["openai"])   # 启用对 OpenAI 调用的追踪
client = OpenAI(api_key="<YOUR_KEY>")

response = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "Tell me a funny joke!"}]
)

print("Energy consumption:", response.impacts.energy.value.mean, "kWh")
print("GHG emissions:",    response.impacts.gwp.value.mean, "kgCO2eq")

response.impacts 对象提供能源（kWh）和全球变暖潜势（kg CO₂‑eq）的平均（以及可能的分布）估计。

关键特性

  • Provider‑agnostic：通过可选 extras 支持主要 LLM API。
  • 量化指标：返回电力使用和 CO₂‑当量排放。
  • 轻量集成：只需几行代码即可开始追踪。
  • 开源与社区驱动：属于 CodeCarbon 非营利组织，采用 MIT‑style MPL‑2.0 许可证。
  • 文档与工具：完整文档位于 https://ecologits.ai，提供 Colab notebook 与 Discord 社区支持。

使用者 – 研究人员、产品团队和可持续发展官员，需要审计 AI 服务的环境成本。

贡献 – 文档中提供贡献指南和开发环境设置（见 Contributing to EcoLogits）。项目欢迎贡献，并得到多家赞助商的支持。

EcoLogits 让生成式 AI 隐藏的能源账单可见，促进更负责任的开发与报告。