Getting Started

From installation to your first axiomatic re-ranking

This section introduces the main building blocks of ir_axioms:

1. Install the package and its optional dependencies.
2. Quick start to compute your first axiomatic preferences and re-rank a small ranking.
3. Learn about core concepts like the Axiom interface, preferences, operators, and tools.
4. Integrate ir_axioms with PyTerrier, Pyserini, and ir_datasets.
5. Migrate code written for legacy ir_axioms.

Once you know the basics, continue by browsing our extensive catalog of axioms or follow one of the more detailed walkthroughs.