Skip to main content

Installation

Gaussia uses a modular dependency system, allowing you to install only the components you need.

Requirements

  • Python 3.11 or higher
  • uv (recommended) or pip

Basic Installation

uv add gaussia

Optional Dependencies

Gaussia provides optional dependency groups for each metric and feature:

Metrics

ExtraDescriptionDependencies
toxicityToxicity metric with clusteringsentence-transformers, hdbscan, umap-learn, nltk, numpy, pandas
biasBias metric with guardian modelstorch
visionVision similarity and hallucinationnumpy, sentence-transformers, torch
humanityHumanity metric with NRC lexiconnumpy, pandas
regulatoryRegulatory compliance metrictorch, accelerate

Features

ExtraDescriptionDependencies
generatorsSynthetic dataset generationlangchain-core
explainabilityToken attribution analysisinterpreto, torch, transformers
prompt-optimizerPrompt optimizationoptuna

Combined Extras

ExtraDescription
metricsAll metric extras combined
allAll metrics and features

Installation Examples

# Install with toxicity metric support
uv add "gaussia[toxicity]"

LLM Provider Dependencies

Several metrics require LangChain-compatible chat models. Install your preferred provider:
uv add langchain-openai

Verifying Installation

import gaussia

# Check version
print(f"Gaussia version: {gaussia.__version__}")

# Verify imports
from gaussia.metrics.toxicity import Toxicity
from gaussia.core.retriever import Retriever
from gaussia.schemas.common import Dataset, Batch

print("Installation successful!")

Troubleshooting

Install the toxicity extras:
uv add "gaussia[toxicity]"
Install your preferred LLM provider:
uv add langchain-openai
For CPU-only installation:
uv add torch --index-url https://download.pytorch.org/whl/cpu
uv add "gaussia[toxicity]"
Ensure you’re using Python 3.11+:
python --version
# If needed, use pyenv to install a compatible version
pyenv install 3.11.0
pyenv local 3.11.0

Next Steps

Quickstart

Run your first evaluation

Core Concepts

Understand the architecture