README.md

Evaluation

We support evaluation for all the presses implemented in the library, on a variety of popular benchmarks.

Quick Start 🚀

Evaluation requires some additional packages. You can install them with uv sync --extra eval

Running evaluation is straightforward! Make sure you are in the evaluation directory, then:

1. Configure your evaluation - Edit evaluate_config.yaml to specify your method, press, and dataset
2. Run the evaluation - Execute the script: python evaluate.py

The script will read from evaluate_config.yaml and run inference accordingly. If you want, you can override the settings via command line, for instance:

python evaluate.py --dataset loogle --data_dir shortdep_qa --model meta-llama/Meta-Llama-3.1-8B-Instruct --press_name expected_attention --compression_ratio 0.5

or pass a custom configuration file:

python evaluate.py --config_file <your_config.yaml>

💡 Results (predictions & metrics) are automatically saved to the output_dir directory .

Configuration

Customize your evaluation by editing evaluate_config.yaml. This allows you to flexibly configure a variety of settings, like the fraction of dataset to use (for quick testing) and the model arguments (e.g. for scaling RoPE). For complete parameter details, see the evaluation_config.yaml

💡 Set query_aware: true to include the question in the context during compression. This enables query-aware compression as used in methods like SnapKV and FinchPress.

Available Presses and Datasets

We support evaluation with all the presses implemented in the library (and possible combinations).

• All implemented presses are listed in the PRESS_REGISTRY variable in evaluate_registry.py.
• All implemented dataset are listed in DATASET_REGISTRY variable in evaluate_registry.py.

At the moment, we support the following standard popular benchmarks:

• Loogle (hf link)
• RULER (hf link)
• Zero Scrolls (hf link)
• Infinitebench (hf link)
• longbench(hf link)
• longbench-v2(hf link)
• Needle in a Haystack([hf link]Paul Graham's essays)

Each dataset directory is structured as follows:

$dataset
├── README.md
├── calculate_metrics.py
├── create_huggingface_dataset.py

Where:

• create_huggingface_dataset.py is a script that generates the Hugging Face dataset from the original dataset. Each dataset is associated with a set of parquet files with the following structure:
  • context: ...
  • question: ...
  • answer_prefix: ...
  • answer: ...
  • max_new_tokens: ...
• calculate_metrics.py is a script that calculates the metrics based on the output of evaluate.py

Multi GPU Evaluation

Use the provided evaluate.sh script to run multiple presses simultaneously across different GPUs with varying compression ratios.

Leaderboard 🥇

After evaluating your model, you can easily submit it to the KVPress Leaderboard on Hugging Face! Just copy the output directory in the huggingface space, and your method will soon be displayed in the leaderboard.