Skip to main content

Generate evaluation criteria for any question using LLMs

Project description

1Q1W (One Question One World)

Generate a set of unique evaluation criteria from one question or a list of questions using LLMs. The pipeline expands scenarios, perspectives, and criteria through multiple iterations, then deduplicates and assigns scores.

Installation

From PyPI:

pip install oneq1w

From GitHub:

pip install "oneq1w @ git+https://github.com/mims-harvard/1Q1W.git"

From local clone (for development):

git clone https://github.com/mims-harvard/1Q1W.git
cd 1Q1W
pip install -e .

API Keys (.env)

Create a .env file in the project root with the keys for your chosen provider:

# OpenAI (default)
OPENAI_API_KEY=sk-...

# Azure OpenAI
AZURE_OPENAI_API_KEY=...
AZURE_OPENAI_ENDPOINT=https://your-resource.openai.azure.com

# Claude
ANTHROPIC_API_KEY=sk-ant-...

# Gemini
GOOGLE_API_KEY=...   # or GEMINI_API_KEY

# Grok
XAI_API_KEY=...

# DeepSeek
DEEPSEEK_API_KEY=...

# vLLM
VLLM_SERVER_URL=http://localhost:8000/v1

Load API keys before running or use python-dotenv to load .env in your script.

Quick Start

from oneq1w import CriteriaGenerator

gen = CriteriaGenerator(model="gpt-4o")

# Single question (string)
result = gen.generate("What is machine learning?")
print(result["final_criteria"])

# Single question (dict)
result = gen.generate({"id": "q1", "question": "What is AI?"})

# Batch
results = gen.generate([
    {"id": "q1", "question": "What is AI?"},
    {"id": "q2", "question": "How does deep learning work?"},
])

Input Arguments

1. CriteriaGenerator Init Parameters

Parameter Type Default Description
model str "gpt-4.1" Model name (auto-detects provider)
base_url str None API base URL (required for vLLM)
api_key str None API key (uses env vars if not provided)
temperature float 0.4 Generation temperature
embedding_model str "text-embedding-3-small" Model for embeddings (deduplication)
n_scenario_expands int 3 Scenario expansion iterations
n_perspective_expands int 4 Perspective expansion iterations
n_criteria_expands int 3 Criteria expansion iterations
dedup_threshold float 0.6 Cosine similarity threshold for deduplication (0-1)
max_workers int 8 Parallel workers for batch processing
max_retries int 5 Max retries on rate limit errors
debug bool False Print raw LLM outputs for debugging

2. generate() Input Arguments

Input Type Format Required Optional
str "question text"
dict {"id": "...", "question": "..."} id, question image, web_content
list [{...}, {...}] each item has id, question image, web_content per item
  • id: Identifier for the question (auto-assigned if omitted).
  • question: The question text.
  • image: Base64 string (with or without data:image/...;base64, prefix) for vision-capable models.
  • web_content: Retrieved web context; appended to the question as [Retrieved Web Context] ... [End of Web Context].

Output Format

{
    "id": "q1",
    "question": "What is AI?",
    "scenarios": [...],
    "raw_perspectives": [...],
    "reviewed_perspectives": [...],
    "raw_criteria": [...],
    "reviewed_criteria": [...],
    "final_criteria": [
        {"criterion": "Explains core concepts", "points": 3},
        {"criterion": "Provides examples", "points": 2},
    ],
}

Supported Models

Provider Models Env Variable
OpenAI gpt-4o, gpt-4, o1-mini, o3-mini, o4-mini OPENAI_API_KEY
Azure OpenAI gpt-4o, gpt-4 AZURE_OPENAI_API_KEY, AZURE_OPENAI_ENDPOINT
Claude claude-3-opus, claude-3-sonnet, claude-3-haiku ANTHROPIC_API_KEY
Gemini gemini-pro, gemini-1.5-pro, gemini-2.0-flash GOOGLE_API_KEY
Grok grok-2, grok-3 XAI_API_KEY
DeepSeek deepseek-chat, deepseek-reasoner DEEPSEEK_API_KEY
vLLM any model VLLM_SERVER_URL or base_url param

vLLM: Uses a separate server for hosting. You need to install the vLLM package suitable for your server environment or use the official vLLM Docker image. Once the server is running, provide the model name and the server URL (e.g. VLLM_SERVER_URL=http://localhost:8000/v1 or base_url when initializing CriteriaGenerator).

Data

Raw data and generated criteria (gpt-4.1 with scenario expand x3, perspective expand x4, criteria expand x3) are available at https://huggingface.co/datasets/suyc21/1Q1W.

Test Scripts

This folder contains several test scripts:

Script Description
test_providers.py Tests different providers (OpenAI, Claude, Gemini, Grok, DeepSeek, vLLM) on HealthBench sample data or HLE sample data. Usage: python test_providers.py --provider openai
test_pipeline.py Tests generating HealthBench data using gpt-4.1.
evaluate_criteria.py Evaluates pre-generated criteria against expert rubrics. Computes coverage and uniqueness metrics. Use --analyze-only to compute scores only without re-running LLM evaluation. Usage: python evaluate_criteria.py -i results.json --analyze-only

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

oneq1w-0.1.1.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

oneq1w-0.1.1-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

Details for the file oneq1w-0.1.1.tar.gz.

File metadata

  • Download URL: oneq1w-0.1.1.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for oneq1w-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c5f1e9bf7b627d477a183565eeb390d967a083828ddc62d4fd05129039eb0bbe
MD5 2be0d47fbcf66b4d7de3f27fe41c1738
BLAKE2b-256 75ae427247f50611d79739cb1b151c149374325b4cb19f2978670fcf7488c995

See more details on using hashes here.

File details

Details for the file oneq1w-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: oneq1w-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 21.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for oneq1w-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 96cca5c20ed0c4b6ba791bca3b3eb70eb2a19c7e66f1f1e77bec26eb4a4ccd9c
MD5 551578e5a1c30ecd1700cd2344047d75
BLAKE2b-256 cd14bf0717668596dee413fa53efcb2c842c909c07c06d7b03188beb591b27a0

See more details on using hashes here.

Supported by

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