elinor 0.2.0

Evaluation Library in Information Retrieval
Documentation

Elinor: Evaluation Library in INfOrmation Retrieval

Elinor is a Rust library for evaluating information retrieval systems, inspired by ranx and Sakai's book.

It provides a comprehensive set of tools and metrics tailored for information retrieval engineers, offering an intuitive and easy-to-use interface.

Key features

  • IR-focused design: Elinor is tailored specifically for evaluating information retrieval systems, with an intuitive interface designed for IR engineers. It offers a streamlined workflow that simplifies common IR evaluation tasks.
  • Comprehensive evaluation metrics: Elinor supports a wide range of key evaluation metrics, such as Precision, MAP, MRR, and nDCG. The supported metrics are available in Metric. The evaluation results are validated against trec_eval to ensure accuracy and reliability.
  • Statistical testing: Elinor includes several statistical tests such as Student's t-test to verify the generalizability of results. It provides not only p-values but also other statistics, such as effect sizes and confidence intervals, for thorough reporting.

API documentation

See https://docs.rs/elinor/.

Or, you can build and open the documentation locally by running the following command:

RUSTDOCFLAGS="--html-in-header katex.html" cargo doc --no-deps --open

Licensing

Licensed under either of

at your option.