elinor 0.2.1

Evaluation Library in Information Retrieval
Documentation

Elinor: Evaluation Library in INfOrmation Retrieval

Elinor is a Rust library for evaluating information retrieval (IR) systems. It provides a comprehensive set of tools and metrics tailored for IR engineers, offering an intuitive and easy-to-use interface.

Key features

  • IR-specific design: Elinor is tailored specifically for evaluating IR 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.
  • In-depth statistical testing: Elinor includes several statistical tests, such as Student's t-test or Randomized Tukey HSD test, to verify the generalizability of results. Not only p-values but also other statistics, such as effect sizes and confidence intervals, are provided for thorough reporting. See the statistical_tests module for more details.

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.