mteb/mkdocs.yml at main · embeddings-benchmark/mteb · 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
site_name: Massive Text Embedding Benchmark
docs_dir: "docs/"
repo_url: https://github.com/embeddings-benchmark/mteb
watch: [mteb/, docs/]
edit_uri: "blob/main/docs/"
theme:
  favicon: images/logos/mteb_logo/dots-icon.png
  logo: images/logos/mteb_logo/dots-icon.png
  features:
    - navigation.tracking
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.annotate
    - content.code.annotation
    - content.tabs.link
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.path
    - toc.follow
  palette:
    # System preference (auto)
    - media: "(prefers-color-scheme)"
      scheme: default
      primary: white
      accent: light blue
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: light blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
      toc_depth: 3
  - footnotes
  - attr_list
  - md_in_html
  - tables
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Get Started:
      - index.md
      - installation.md
      - whats_new.md
      - Usage:
        - Get Started: get_started/usage/get_started.md
        - Define the Model: get_started/usage/defining_the_model.md
        - Select Benchmarks: get_started/usage/selecting_tasks.md
        - Run the Evaluation: get_started/usage/running_the_evaluation.md
        - Load Results: get_started/usage/loading_results.md
        - Command Line: get_started/usage/cli.md
        - Run the Leaderboard: get_started/usage/leaderboard.md
      - Examples:
        - get_started/advanced_usage/bm25.md
        - Cache embeddings: get_started/advanced_usage/cache_embeddings.md
        - Retrieval backend: get_started/advanced_usage/retrieval_backend.md
        - Two stage reranking: get_started/advanced_usage/two_stage_reranking.md
        - vLLM: get_started/advanced_usage/vllm_wrapper.md

  - Contributing:
      - Adding a Model: contributing/adding_a_model.md
      - Submit Results: contributing/submitting_results.md
      - Adding a Task: contributing/adding_a_dataset.md
      - Adding a Benchmark: contributing/adding_a_benchmark.md
      - CONTRIBUTING.md
  - Overview:
      - overview/index.md
      - Benchmarks:
        - Available Benchmarks: overview/available_benchmarks.md
      - Models:
        - Text: overview/available_models/text.md
        - Multimodal: overview/available_models/multimodal.md
        - Image: overview/available_models/image.md
        - Image Text: overview/available_models/image_text.md
        - Audio: overview/available_models/audio.md
        - Audio Text: overview/available_models/audio_text.md
      - Tasks:
        - overview/available_tasks/retrieval.md
        - overview/available_tasks/classification.md
        - overview/available_tasks/clustering.md
        - overview/available_tasks/semantic-similarity.md
        - overview/available_tasks/pair-classification.md
  - API:
      - Overview: api/index.md
      - Evaluation: api/evaluation.md
      - Benchmark: api/benchmark.md
      - Task: api/task.md
      - Model: api/model.md
      - Results: api/results.md
      - Additional Types: api/types.md
  - Leaderboard: https://huggingface.co/spaces/mteb/leaderboard

copyright: This site made available under a Creative Commons Attribution 4.0 license

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [mteb]
          type: python
          root_package: mteb
          docstring_style: google
          options:
            heading_level: 3
            show_source: true
            show_root_heading: true

extra_javascript:
  - javascripts/extra.js
extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/embeddings-benchmark/mteb

validation:
  unresolved_references: false