Skip to main content

Language Model Unit Testing Framework

Project description

LMUnit: Fine-grained Evaluation with Natural Language Unit Tests


LMUnit Workflow This repository provides code for evaluation and reproduction of our results in LMUnit: Fine-grained Evaluation with Natural Language Unit Tests.

๐Ÿš€ Recent Updates

  • 2025-07: Open-Sourced LMUnit checkpoints Llama 3.1-70B and Qwen 2.5-72B models. Besides, evaluation framework for reproducing our direct scoring and preference tasks results

๐Ÿ“‹ Table of Contents

๐Ÿ”ง LMUnit Inference Example

from lmunit import LMUnit
from vllm import SamplingParams

# Initialize LMUnit with your model
model = LMUnit(
    model_path="ContextualAI/LMUnit-llama3.1-70b", 
    tp_size=4
)

sampling_params = SamplingParams(temperature=0.0, max_tokens=10, logprobs=20)
# Define your evaluation prompt

unit_test = "Does the response specify minimum system logs required for compliance?"

query =  "What security validation protocols ensure HIPAA compliance when connecting research databases to clinical systems?"



response = """Customer Concentration Risk Comparison:
Snowflake's Platform segment shows higher concentration risk than Product segment:

Product: 15% (Customer X), 8% (Customer Y), 77% others
Platform: 20% (Customer Z), 5% (Customer W), 75% others

HIPAA Technical Controls:
Data Encryption Requirements:

Regulation: 45 CFR ยง 164.312(a)(2)(iv)
Validation: All data encrypted at rest/transit using FIPS 140-2 algorithms
Testing: Vulnerability scanning and penetration testing for encryption weaknesses

Additional Compliance Measures:

Risk analysis for security threats
Access controls for PHI authorization
Incident response planning
Required logs: encryption key management, data access, security incidents"""

prompt = f"Query: {query}\n\nResponse: {response}\n\nUnit Test: {unit_test}"

output = model.generate(prompt, sampling_params)

๐Ÿ“ Repository Structure

lmunit/
โ”œโ”€โ”€ assets/                 # Documentation assets and figures
โ”œโ”€โ”€ eval/                   # Evaluation scripts and benchmarks
โ”‚   โ”œโ”€โ”€ eval.py             # Main evaluation script
โ”‚   โ””โ”€โ”€ reward_bench2.py    # Reward benchmarking utilities
โ”œโ”€โ”€ lmunit/                 # Core LMUnit package
โ”‚   โ”œโ”€โ”€ __init__.py         # Package initialization
โ”‚   โ”œโ”€โ”€ constants.py        # Framework constants
โ”‚   โ”œโ”€โ”€ lmunit.py           # Main LMUnit class implementation
โ”‚   โ”œโ”€โ”€ metrics.py          # Evaluation metrics
โ”‚   โ””โ”€โ”€ tasks.py            # Task definitions and utilities
โ”œโ”€โ”€ requirements/           # Dependencies
โ”‚   โ”œโ”€โ”€ requirements.txt    # Main dependencies  
โ”‚   โ””โ”€โ”€ dev.txt             # Development dependencies
โ””โ”€โ”€ requirements-dev.txt    # Legacy dev dependencies

๐Ÿ“„ Artifacts

๐Ÿ“‹ Paper

๐Ÿค— HuggingFace Collection

๐Ÿ’พ Checkpoints

Model Flask BiGGen-Bench Human-Internal InfoBench RB LFQA RB2
LMUnit-LLaMA-3.1-70B 72.03 67.69 93.63 89.00 91.56 76.15 80.5
LMUNIT_Qwen2.5-72B 73.85 69.56 94.44 88.67 91.13 73.85 82.1

๐Ÿš€ Quick Start

Installation

pip install -r requirements/requirements.txt
pip install -e .

Run Evaluation Task

For running an specific task on an LMUnit model

python eval/eval.py --task <task> --model-path <lmunit-model> --tensor-parallel-size <tp-size>

For running rewardbench2 results:

python eval/reward_bench2.py --model-path <lmunit-model> --tensor-parallel-size <tp-size>

Citation

@misc{saadfalcon2024lmunitfinegrainedevaluationnatural,
      title={LMUnit: Fine-grained Evaluation with Natural Language Unit Tests}, 
      author={Jon Saad-Falcon and Rajan Vivek and William Berrios and Nandita Shankar Naik and Matija Franklin and Bertie Vidgen and Amanpreet Singh and Douwe Kiela and Shikib Mehri},
      year={2024},
      eprint={2412.13091},
      archivePrefix={arXiv},
      primaryClass={cs.CL},
      url={https://arxiv.org/abs/2412.13091}, 
}

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

lmunit-0.1.1.tar.gz (390.7 kB view details)

Uploaded Source

Built Distribution

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

lmunit-0.1.1-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lmunit-0.1.1.tar.gz
  • Upload date:
  • Size: 390.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.15

File hashes

Hashes for lmunit-0.1.1.tar.gz
Algorithm Hash digest
SHA256 33b0bffcc4604223c42ab9656e0c30c2c904080280482137948ba1ebe8634f2f
MD5 940eac7fb4c701b0854ec6eab038bf51
BLAKE2b-256 1a1853a0b4f947933a6ae8c74af973f2401e6c40870bfaab42a237efac5203f8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lmunit-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.15

File hashes

Hashes for lmunit-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e54253cbeb91afdd5c3d7ee5a05769d5d697db0a471e5119dd7c01b2b2b33f2b
MD5 cd65f0f7a8d7887088fc9912788e070c
BLAKE2b-256 e9f4dd61865133297d168fa9834f5fc4d126afcde858dc2085ec2ec850ba7ac3

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