LOOM-Eval Logo

Getting Started

  • Installation
    • System Requirements
    • Basic Installation
      • Step 1: Create Environment
      • Step 2: Install LOOM-Eval
      • Step 3: Install Flash Attention
    • Acceleration Methods
      • General Acceleration Environment
      • KIVI Installation
      • ThinK Installation
      • FlexPrefill Installation
      • XAttention Installation
      • Other Acceleration Methods
    • RAG Installation
    • Next Steps
  • Quick Start
    • Prerequisites
      • System Requirements
      • Installation
    • Basic Usage
      • Automatic Evaluation (Recommended)
      • Manual Evaluation (Step-by-Step)
    • Key Parameters
      • Core Parameters
      • Advanced Parameters
    • WebUI Usage
      • Interactive Evaluation
    • Example Scenarios
      • Scenario 1: Quick Test with Lightweight Mode
      • Scenario 2: Multi-GPU Long Context Evaluation
      • Scenario 3: Using vLLM for Faster Inference
      • Scenario 4: API Interface Usage
      • Scenario 5: RAG-Enhanced Evaluation
      • Scenario 6: Acceleration for Memory Efficiency
    • Running LOOMBench Suite
      • Option 1: Individual Benchmarks
      • Option 2: Full Suite Automation
    • Custom Templates
    • Data Download Instructions
    • Troubleshooting
      • Common Issues
    • Output Structure

User Guide

  • Benchmarks
    • Overview
    • Running a Benchmark
      • Basic Command
      • Example: L_CiteEval
    • LOOMBench (Lightweight Suite)
    • All Benchmarks
      • Faithfulness Benchmarks
      • General Benchmarks
      • Generation Benchmarks
      • Reasoning Benchmarks
      • Retrieval Benchmarks
      • Reward Benchmarks
      • Specialization Benchmarks
  • Acceleration Methods
    • KV Cache Optimization
    • Sparse Attention
    • Usage
    • Performance (128K Context)
    • Model Compatibility
    • Installation Notes
    • Hardware Requirements
  • API Reference
    • Command Line Interface
      • Main Commands
      • Core Parameters
      • Inference Options
      • Acceleration Options
      • RAG Options
      • Extension Options
      • Storage Strategy Options
    • Custom Templates
    • Examples
      • Basic Evaluation
      • With Acceleration
      • With RAG
      • vLLM Backend
      • API Model
  • RAG (Retrieval-Augmented Generation)
    • Supported Methods
    • Installation
    • Quick Start
    • Configuration
    • Command-line Options
    • Task Compatibility
    • Best Practices
LOOM-Eval
  • LOOM-Eval Documentation
  • View page source

LOOM-Eval Documentation

Welcome to LOOM-Eval, a comprehensive framework for evaluating long-context language models.

LOOM-Eval Logo

Overview

LOOM-Eval provides:

  • Comprehensive Benchmarks: 22 standard long-context benchmarks

  • Efficient Inference: Support for vLLM and 12 acceleration methods

  • Model Compatibility: Works with Transformers, Mamba, and RWKV

  • Easy to Use: Simple command-line interface and WebUI

Getting Started

  • Installation
    • System Requirements
    • Basic Installation
    • Acceleration Methods
    • RAG Installation
    • Next Steps
  • Quick Start
    • Prerequisites
    • Basic Usage
    • Key Parameters
    • WebUI Usage
    • Example Scenarios
    • Running LOOMBench Suite
    • Custom Templates
    • Data Download Instructions
    • Troubleshooting
    • Output Structure

User Guide

  • Benchmarks
    • Overview
    • Running a Benchmark
    • LOOMBench (Lightweight Suite)
    • All Benchmarks
  • Acceleration Methods
    • KV Cache Optimization
    • Sparse Attention
    • Usage
    • Performance (128K Context)
    • Model Compatibility
    • Installation Notes
    • Hardware Requirements
  • API Reference
    • Command Line Interface
    • Custom Templates
    • Examples
  • RAG (Retrieval-Augmented Generation)
    • Supported Methods
    • Installation
    • Quick Start
    • Configuration
    • Command-line Options
    • Task Compatibility
    • Best Practices

Quick Links

  • Index

  • Search Page

  • Project Page

  • Overview Page

Next

© Copyright 2025, LCM-lab.

Built with Sphinx using a theme provided by Read the Docs.