Skip to content

_ecologits

EcoLogits

EcoLogits instrumentor to initialize function patching for each provider.

Examples:

EcoLogits initialization example with OpenAI.

from ecologits import EcoLogits
from openai import OpenAI

EcoLogits.init(providers=["openai"])

client = OpenAI(api_key="<OPENAI_API_KEY>")
response = client.chat.completions.create(
    model="gpt-4o-mini",
    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")

init(providers=None, electricity_mix_zone='WOR') staticmethod

Initialization static method. Will attempt to initialize all providers by default.

Parameters:

Name Type Description Default
providers Optional[Union[str, list[str]]]

list of providers to initialize (must select at least one provider).

None
electricity_mix_zone str

ISO 3166-1 alpha-3 code of the electricity mix zone (WOR by default).

'WOR'
Source code in ecologits/_ecologits.py
@staticmethod
def init(
    providers: Optional[Union[str, list[str]]] = None,
    electricity_mix_zone: str = "WOR",
) -> None:
    """
    Initialization static method. Will attempt to initialize all providers by default.

    Args:
        providers: list of providers to initialize (must select at least one provider).
        electricity_mix_zone: ISO 3166-1 alpha-3 code of the electricity mix zone (WOR by default).
    """
    if isinstance(providers, str):
        providers = [providers]
    if providers is None:
        warnings.warn(
            "Initializing EcoLogits without defining providers will soon no longer be supported. For example "
            "with OpenAI, you should use `EcoLogits.init(providers=['openai'])` instead.",
            DeprecationWarning,
            stacklevel=2
        )

        providers = list(_INSTRUMENTS.keys())

    init_instruments(providers)

    EcoLogits.config.electricity_mix_zone = electricity_mix_zone
    EcoLogits.config.providers += providers
    EcoLogits.config.providers = list(set(EcoLogits.config.providers))