Neutral, local-first AI regression-testing tool (明镜 / Evalith)
Project description
明镜 / Evalith
English | 中文
Catch AI regressions before your users do.
A neutral, local-first AI regression-testing tool. Define a test set, run it against any model (DeepSeek / Qwen / OpenAI / Claude / …), score every case, and diff two runs to see exactly what got better or worse — then gate CI so a prompt or model change can't silently break your product.
Why Evalith
- Neutral & open. Your evaluation harness decides which model wins, so it shouldn't be owned by a model vendor. Evalith is vendor-independent and open source (Apache-2.0).
- Local-first. The core workflow runs entirely on your machine — no account, no upload, no network. Your prompts and test data stay with you.
- China models first-class. DeepSeek, Qwen and global models are first-class
aliases (
evalith models); a Chinesellm_judgeships in the box. - Regressions, not vibes.
diffand--fail-on-regressiontell you which cases improved, regressed, or broke when you change a prompt, model, or version.
Install
Requires Python ≥ 3.10.
pip install evalith # core: pydantic, pyyaml, typer
pip install "evalith[litellm]" # optional: real models (DeepSeek/Qwen/OpenAI/Claude/...)
Or from source: git clone https://github.com/dominciyue/Evalith_MingJing then pip install -e ".[litellm]".
Quickstart (offline, no API key)
# 1. Run the example eval — uses the offline `echo` model, passes 2/2
evalith run examples/eval.yaml
# 2. Tweak your prompt/model in examples/eval.yaml, then run again
evalith run examples/eval.yaml
# 3. List runs, then diff the two newest to spot regressions
evalith list
evalith diff <OLDER_RUN_ID> <NEWER_RUN_ID>
Gate CI on regressions
Fail a build when quality drops — two ways:
# Absolute gate: fail if fewer than 90% of checks pass (no baseline needed)
evalith run examples/eval.yaml --fail-under 0.9
# Relative gate: fail if any case regressed vs a baseline run
evalith diff <BASELINE_RUN_ID> <NEW_RUN_ID> --fail-on-regression
Both exit non-zero on failure, so CI stops the PR. This repo ships a composite
GitHub Action — drop this into .github/workflows/eval.yml:
name: AI eval gate
on: [pull_request]
jobs:
eval:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dominciyue/Evalith_MingJing@main
with:
config: examples/eval.yaml
fail-under: "0.9"
(See .github/workflows/eval-example.yml for a working copy using the offline demo.)
Catch regressions vs a baseline. diff accepts run IDs or .json file paths, so CI needs no shared state — bless a baseline once, commit it, then compare each PR's fresh run against it:
evalith run examples/eval.yaml --out baseline.json # bless once, commit baseline.json
# then, in CI on a PR:
evalith run examples/eval.yaml --out current.json
evalith diff baseline.json current.json --fail-on-regression
Shareable reports
Turn a run or a diff into Markdown (for PR comments) or a self-contained HTML page:
evalith report <RUN_ID> --format md # Markdown to stdout
evalith report <RUN_ID> --format html --output report.html # standalone HTML file
evalith diff <A> <B> --format md --output diff.md # diff as Markdown
Reports include the pass rate, mean score, and — for real models — cost, token count, and latency.
Using real models (国产 first-class)
evalith models # list first-class aliases + the env var each needs
export DEEPSEEK_API_KEY=sk-...
evalith run examples/eval.deepseek.yaml --concurrency 3
# -> Run <id> saved to .evalith/runs/<id>.json — 6/6 checks passed
Set model: to an alias (deepseek-chat, deepseek-reasoner, qwen-max,
qwen-plus) or any LiteLLM id directly (gpt-4o-mini, claude-3-5-sonnet, …),
then set that provider's API key. The llm_judge scorer can grade in Chinese with
params: {language: zh}.
Scale
--concurrency Nruns cases in parallel (provider calls are I/O-bound), or setconcurrency:in the config. Order of results is always preserved.- Datasets load from YAML, JSON, CSV, or JSONL (
examples/qa.jsonl).
Scorers
| type | passes when |
|---|---|
exact_match |
output equals the case's expected |
contains |
output contains params.text (or the case's expected) |
regex |
output matches params.pattern |
llm_judge |
an LLM grades the output against params.criteria (params.language: en|zh) |
How it works
run evaluates a config against a model and saves a Run — a JSON snapshot of
every case's output, scores, tokens, cost, and latency — to .evalith/runs/.
diff compares two saved runs case-by-case and labels each improved / regressed
/ unchanged / new / removed.
Status
v0.3 — single-turn prompt evaluation, file-based run store, run-to-run diff with
per-case output comparison, CI gating (--fail-under, --fail-on-regression,
file-based baselines, GitHub Action), Markdown/HTML reports, concurrency with
per-case error isolation, cost/token/latency tracking, and 国产 model aliases
with a Chinese judge. Team/cloud features are on the roadmap. Issues and PRs welcome.
License
Apache-2.0. Copyright © 2026 Evalith (明镜) Authors.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file evalith-0.3.0.tar.gz.
File metadata
- Download URL: evalith-0.3.0.tar.gz
- Upload date:
- Size: 53.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6c901783aa774b60bac2ef8068cf2c4fe7ce2b04f1ef0877feb0f17dcd08ec3b
|
|
| MD5 |
b0757fb634fe24dbad71b000878dd1cd
|
|
| BLAKE2b-256 |
988a30f5d4f6978340d082150e282e24a35fe4b5b21047c5f923bb23b72385a6
|
File details
Details for the file evalith-0.3.0-py3-none-any.whl.
File metadata
- Download URL: evalith-0.3.0-py3-none-any.whl
- Upload date:
- Size: 21.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c5a110537737bba60743449212fb2abaf45b1d9cc4a7c0c1dcd6224ca5b67ee0
|
|
| MD5 |
dc37f1a33f11ec5b8ca682af9e6309cc
|
|
| BLAKE2b-256 |
355924615fd87cc0921d6722568b94fc1945022cf1a442af7c4a0acd480de5e9
|