Skip to content

Installing beir

Jump to bottom
Nandan Thakur edited this page Jun 4, 2025 · 3 revisions

🍻 Installing BEIR

One can easily install the BEIR repository using a single command line. Tested with Python versions 3.9+.

[Stable] Using pip version

pip install beir

[Optional] optional packages

pip install beir[faiss]
pip install beir[peft]
...

Build or develop with BEIR

$ git clone https://github.com/beir-cellar/beir.git
$ cd beir
$ pip install -e .

📚 Citation

If you use the BEIR benchmark in your research, please cite the BEIR paper: https://openreview.net/forum?id=wCu6T5xFjeJ.

Home

Quick Start

Installing BEIR

Examples and Tutorials

Datasets

Datasets Available

Multilingual Datasets

Load your Custom Dataset

Models

Models Available

Evaluate your Custom Model

Metrics

Metrics Available

Miscellaneous

Leaderboard

Couse Material on IR

Clone this wiki locally