AutoRAG-Research/mkdocs.yml at main · NomaDamas/AutoRAG-Research · GitHub

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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
site_name: AutoRAG-Research
repo_url: https://github.com/NomaDamas/AutoRAG-Research
site_url: https://NomaDamas.github.io/AutoRAG-Research
site_description: Automate your RAG research.
site_author: NomaDamas
edit_uri: edit/main/docs/
repo_name: NomaDamas/AutoRAG-Research
copyright: Maintained by <a href="https://NomaDamas.com">NomaDamas</a>.

nav:
  - Home: index.md
  - Learn:
      - learn/index.md
      - Core Concepts: learn/concepts.md
      - Architecture: learn/architecture.md
  - Tutorial:
      - tutorial/index.md
      - First Steps: tutorial/first-steps.md
      - Text Retrieval: tutorial/text-retrieval.md
      - Text RAG: tutorial/text-rag.md
      - Multimodal: tutorial/multimodal.md
      - Custom Dataset: tutorial/custom-dataset.md
      - Custom Pipeline: tutorial/custom-pipeline.md
      - Custom Metric: tutorial/custom-metric.md
  - Datasets:
      - datasets/index.md
      - Text:
          - datasets/text/index.md
          - datasets/text/beir.md
          - datasets/text/mteb.md
          - datasets/text/ragbench.md
          - datasets/text/mrtydi.md
          - datasets/text/bright.md
      - Multimodal:
          - datasets/multimodal/index.md
          - datasets/multimodal/vidore.md
          - datasets/multimodal/vidorev2.md
          - datasets/multimodal/vidorev3.md
          - datasets/multimodal/visrag.md
          - datasets/multimodal/open-ragbench.md
  - Pipelines:
      - pipelines/index.md
      - Retrieval:
          - pipelines/retrieval/index.md
          - pipelines/retrieval/bm25.md
          - pipelines/retrieval/vector-search.md
      - Generation:
          - pipelines/generation/index.md
          - pipelines/generation/basic-rag.md
  - Embeddings:
      - embeddings/index.md
      - embeddings/infinity.md
  - Rerankers:
      - rerankers/index.md
      - rerankers/cohere.md
      - rerankers/jina.md
      - rerankers/voyageai.md
      - rerankers/mixedbreadai.md
      - rerankers/rankgpt.md
      - rerankers/upr.md
  - Metrics:
      - metrics/index.md
      - Retrieval:
          - metrics/retrieval/index.md
          - metrics/retrieval/recall.md
          - metrics/retrieval/full-recall.md
          - metrics/retrieval/precision.md
          - metrics/retrieval/f1.md
          - metrics/retrieval/ndcg.md
          - metrics/retrieval/mrr.md
          - metrics/retrieval/map.md
      - Generation:
          - metrics/generation/index.md
          - metrics/generation/bleu.md
          - metrics/generation/meteor.md
          - metrics/generation/rouge.md
          - metrics/generation/bert-score.md
          - metrics/generation/sem-score.md
          - metrics/generation/response-relevancy.md
  - Plugins:
      - plugins/index.md
      - CLI Reference: plugins/cli.md
      - Retrieval Pipeline: plugins/retrieval-pipeline.md
      - Generation Pipeline: plugins/generation-pipeline.md
      - Metrics: plugins/metrics.md
      - Trust-Align Metrics: plugins/trust-align-metrics.md
      - Best Practices: plugins/best-practices.md
  - Agent Skill: agent-skill/index.md
  - CLI Reference: cli/index.md
  - API Reference: reference/index.md
  - Contributing:
      - contributing/index.md
      - contributing/development-setup.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: ["autorag_research"]
          options:
            show_source: false
            show_root_heading: true
  - mkdocs-typer2:
      pretty: true

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/NomaDamas/AutoRAG-Research
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/AutoRAG-Research

markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - tables
  - attr_list
  - md_in_html

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js