Skip to content

installation.md

Latest commit

 

History

History
235 lines (171 loc) · 6.26 KB

installation.md

File metadata and controls

235 lines (171 loc) · 6.26 KB
Raw

Installation

This guide will help you install StringSight and set up your development environment.

Prerequisites

Required

  • Python 3.8+ (recommended: 3.10 or 3.11)
  • Conda or Miniconda (recommended for environment management)
  • OpenAI API key (required for LLM-powered features)

Optional

  • Node.js 20+ (for React frontend interface - only needed for development)
  • Weights & Biases account (for experiment tracking - optional, install with pip install "stringsight[wandb]")

Quick Installation

1. Create Conda Environment

# Create new conda environment with Python 3.11
conda create -n stringsight python=3.11
conda activate stringsight

2. Install StringSight

# From PyPI (recommended): install core package
pip install stringsight

# Or with all optional extras (ML tools, wandb, etc.)
pip install "stringsight[full]"

# Or, for local development from source:
# git clone --recurse-submodules https://github.com/lisadunlap/stringsight.git
# cd stringsight
# pip install -e ".[full]"

Note: wandb is now optional. Install it separately if needed:

pip install "stringsight[wandb]"  # or: pip install wandb

3. Set API Key(s)

# Add to your shell profile (.bashrc, .zshrc, etc.)
# We use LiteLLM, supporting 100+ providers
export OPENAI_API_KEY="your-api-key-here"
# ... any other provider keys

Local Models: StringSight uses LiteLLM, so you can use vLLM, Ollama, or any OpenAI-compatible server. See the LiteLLM docs for provider-specific setup.

4. Verify Installation

# Test core package
python -c "from stringsight import explain; print('✅ Installation successful!')"

# Test API server
python -m uvicorn stringsight.api:app --reload --host localhost --port 8000

# In another terminal, test health check
curl http://127.0.0.1:8000/health
# Should return: {"ok": true}

Installation Options

Core Package Only

# From PyPI (wandb is optional and not required)
pip install stringsight

# From a local clone (development)
# Note: Requires frontend submodule initialized
git submodule update --init --recursive
pip install -e .

With Development Tools

# From PyPI
pip install "stringsight[dev]"

# From a local clone (development)
pip install -e ".[dev]"

All Features

# From PyPI (recommended for most users)
pip install "stringsight[full]"

# From a local clone (development)
pip install -e ".[full]"

Frontend Setup (Optional)

The React frontend provides an interactive web interface for analyzing results.

# Install Node.js dependencies
cd frontend/
npm install

# Start development server
npm run dev

# Open browser to http://localhost:5173

Docker Setup (Optional)

For multi-user deployments or to run StringSight with all infrastructure dependencies (PostgreSQL, Redis, MinIO), use Docker Compose.

Basic Usage (Production)

# Clone the repository
git clone https://github.com/lisadunlap/stringsight.git
cd stringsight

# Copy the environment template and add your API key
cp .env.example .env
# Edit .env and add your OPENAI_API_KEY

# Start all services (API, workers, database, Redis, MinIO)
docker compose up

# The API will be available at http://localhost:8000

This runs the complete stack with persistent storage for database and object storage.

Docker Development

For active development where you want code changes to reflect immediately:

# Option 1: Use the dev compose file explicitly
docker compose -f docker-compose.yml -f docker/docker-compose.dev.yml up

# Option 2: Copy to override file (auto-loaded by docker compose)
cp docker/docker-compose.dev.yml docker-compose.override.yml
docker compose up

The development setup mounts your local code into the containers, so changes to Python files will automatically reload the API (thanks to uvicorn --reload).

Note for Mac/Windows users: Volume mounts can have slower I/O performance on non-Linux systems. If you experience performance issues, you can either:

  • Use the basic setup (rebuild containers when you make changes)
  • Run the API locally: pip install -e . && uvicorn stringsight.api:app --reload

Verify Full Setup

Backend API Test

# Start backend
python -m uvicorn stringsight.api:app --reload --host localhost --port 8000

# In another terminal
curl http://127.0.0.1:8000/health

Frontend Test

cd frontend/
npm run dev
# Open http://localhost:5173 in your browser

Core Package Test

from stringsight import explain
import pandas as pd

df = pd.DataFrame({
    "prompt": ["What is ML?"],
    "model": ["gpt-4"],
    "model_response": [
        [{"role": "user", "content": "What is ML?"},
         {"role": "assistant", "content": "Machine learning is..."}]
    ]
})

# Should run without errors
clustered_df, model_stats = explain(df, output_dir="test_results")

Troubleshooting

If you encounter any issues during installation, see the Troubleshooting Guide for common problems and solutions.

Environment Variables

StringSight uses the following environment variables:

Variable Required Description
OPENAI_API_KEY Yes OpenAI API key for LLM calls
WANDB_API_KEY No Weights & Biases API key for experiment tracking (requires wandb package)

Dependencies

Core Dependencies

  • pandas, numpy - Data processing
  • scikit-learn - Machine learning utilities
  • hdbscan - Clustering algorithm
  • openai, litellm - LLM API clients
  • sentence-transformers - Local embedding models

Visualization Dependencies

  • plotly - Interactive charts

Frontend Dependencies (npm)

  • react, typescript - Frontend framework
  • @mui/material - UI components
  • @tanstack/react-table - Data tables
  • plotly.js - Interactive charts

Development Dependencies

  • pytest, pytest-cov - Testing
  • black, flake8, mypy - Code quality
  • mkdocs, mkdocs-material - Documentation

Next Steps