Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
145 lines (137 loc) · 4.11 KB
/
Copy pathmkdocs.yml
File metadata and controls
145 lines (137 loc) · 4.11 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
site_name: ir_axioms
site_description: Axiomatic constraints for information retrieval and retrieval-augmented generation.
site_url: https://ir-axioms.webis.de/
site_author: Webis Group
repo_url: https://github.com/webis-de/ir_axioms
repo_name: webis-de/ir_axioms
edit_uri: edit/main/docs/
copyright: >-
© <a href="https://webis.de/">Webis Group</a> ·
Released under the <a href="https://github.com/webis-de/ir_axioms/blob/main/LICENSE">MIT license</a>
docs_dir: docs
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn
exclude_docs: |
# Legacy locations of the documentation (kept as pointers for GitHub readers).
/axioms.md
/rag-axioms.md
/axiom-development.md
/migration-v1.md
*.diff
theme:
name: material
language: en
icon:
repo: fontawesome/brands/github
features:
- content.action.edit
- content.code.annotate
- content.code.copy
- content.tabs.link
- navigation.footer
- navigation.indexes
- navigation.sections
- navigation.tabs
- navigation.top
- navigation.tracking
- search.highlight
- search.suggest
- toc.follow
plugins:
- search
- webis:
bibliography: references.bib
- redirects:
redirect_maps:
rag-axioms.md: axioms/generation.md
axiom-development.md: development/axiom-development.md
migration-v1.md: getting-started/migration.md
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [.]
options:
docstring_style: sphinx
show_root_heading: true
show_source: true
show_signature_annotations: true
separate_signature: true
members_order: source
merge_init_into_class: true
show_if_no_docstring: true
filters: ["!^_"]
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- tables
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
extra_css:
- stylesheets/extra.css
extra_javascript:
- javascripts/mathjax.js
- https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-mml-chtml.js
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/webis-de/ir_axioms
- icon: fontawesome/brands/python
link: https://pypi.org/project/ir-axioms/
- icon: material/web
link: https://webis.de/
nav:
- Home: index.md
- Getting Started:
- getting-started/index.md
- Installation: getting-started/installation.md
- Quickstart: getting-started/quickstart.md
- Core Concepts: getting-started/concepts.md
- Integrations: getting-started/integrations.md
- Migrating from <1.0: getting-started/migration.md
- Axioms:
- axioms/index.md
- Retrieval Axioms: axioms/retrieval.md
- RAG Axioms: axioms/generation.md
- Utility Axioms: axioms/utility.md
- Related Axioms: axioms/related.md
- Walkthroughs:
- walkthroughs/index.md
- Hands-on Tutorial: walkthroughs/hands-on.md
- KwikSort Re-Ranking: walkthroughs/kwiksort.md
- Learning the ORACLE: walkthroughs/kwiksort-learned.md
- Axiomatic LTR Features: walkthroughs/ltr-features.md
- Post-Hoc Analysis: walkthroughs/post-hoc-analysis.md
- Parallel Preferences: walkthroughs/parallel-preferences.md
- Evaluating RAG Responses: walkthroughs/rag-evaluation.md
- Development:
- development/index.md
- Developing Axioms: development/axiom-development.md
- Contributing: development/contributing.md
- Roadmap: development/roadmap.md
- API Reference:
- api/index.md
- Axioms: api/axiom.md
- Data Model: api/model.md
- Tools: api/tools.md
- PyTerrier Integration: api/pyterrier.md