Skip to content

Commit 0d07d33

Browse files
authored
docs: fix docs paths (#4224)
fix docs paths
1 parent 6787a17 commit 0d07d33

File tree

4 files changed

+10
-9
lines changed

4 files changed

+10
-9
lines changed

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: "MTEB"
55
# MTEB
66

77
!!! info
8-
We recently released `mteb` version 2.0.0, to see what is new check of [what is new](get_started/whats_new.md) and see [how to upgrade](get_started/whats_new.md#upgrading-from-v1) your existing code.
8+
We recently released `mteb` version 2.0.0, to see what is new check of [what is new](whats_new.md) and see [how to upgrade](whats_new.md#upgrading-from-v1) your existing code.
99

1010
Welcome documentation of MTEB. `mteb` a package for benchmark and evaluating the quality of embeddings.
1111

@@ -28,7 +28,7 @@ Installation is as simple as:
2828
uv add mteb
2929
```
3030

31-
To see more check out the [installation guide](get_started/installation.md).
31+
To see more check out the [installation guide](installation.md).
3232

3333
## Quickstart
3434

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ If you want to run certain models implemented within mteb you will often need so
3131
uv add "mteb[cohere]"
3232
```
3333

34-
If a specific model requires a dependency it will raise an error with the recommended installation. To see full list of available models you can look at the [models overview](../overview/available_models/text.md).
34+
If a specific model requires a dependency it will raise an error with the recommended installation. To see full list of available models you can look at the [models overview](overview/available_models/text.md).
3535

3636
## Audio Tasks
3737

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
title: "What's New"
23
icon: lucide/newspaper
34
---
45

@@ -83,7 +84,7 @@ print(all_specific_result.model_results)
8384

8485
Added integration with HuggingFace Benchmarks (more info in [blog](https://huggingface.co/blog/community-evals)). This allows for users easily see scores of task directly on dataset card.
8586

86-
![img.png](../images/visualizations/hf_benchmark.png)
87+
![img.png](images/visualizations/hf_benchmark.png)
8788

8889
To convert your task into a HuggingFace benchmark, you can simply run:
8990

@@ -152,7 +153,7 @@ This enables better insight into how users interact with the leaderboard and pro
152153
### Added vLLM support
153154

154155
Added vLLM support. While it is currently not the reference implementation for any models it allows you to run comparisons on performance and throughput
155-
on a single model. This can inform whether it is worth switching your local setup over to vLLM. While you can read more about it [here](advanced_usage/vllm_wrapper.md)
156+
on a single model. This can inform whether it is worth switching your local setup over to vLLM. While you can read more about it [here](get_started/advanced_usage/vllm_wrapper.md)
156157

157158
## New in v2.6
158159

@@ -424,9 +425,9 @@ We're automatically wrapping `Encoder` and `CrossEncoder` models support `Search
424425

425426
We've added a lot of new documentation to make it easier to get started with MTEB.
426427

427-
- You can see api of our models in tasks in [API documentation](../api/index.md).
428-
- We've added a [getting started guide](usage/get_started.md) to help you get started with MTEB.
429-
- You can see implemented [tasks](../overview/available_tasks/retrieval.md) and [models](../overview/available_models/text.md) in MTEB.
428+
- You can see api of our models in tasks in [API documentation](api/index.md).
429+
- We've added a [getting started guide](get_started/usage/get_started.md) to help you get started with MTEB.
430+
- You can see implemented [tasks](overview/available_tasks/retrieval.md) and [models](overview/available_models/text.md) in MTEB.
430431

431432
#### Better support for loading and comparing results
432433

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ markdown_extensions:
7171
nav:
7272
- Get Started:
7373
- index.md
74-
- Installation: installation.md
74+
- installation.md
7575
- whats_new.md
7676
- Usage:
7777
- Get Started: get_started/usage/get_started.md

0 commit comments

Comments
 (0)