Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "MTEB"
# MTEB

!!! info
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.
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.

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

Expand All @@ -28,7 +28,7 @@ Installation is as simple as:
uv add mteb
```

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

## Quickstart

Expand Down
2 changes: 1 addition & 1 deletion docs/get_started/installation.md → docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ If you want to run certain models implemented within mteb you will often need so
uv add "mteb[cohere]"
```

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).
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).

## Audio Tasks

Expand Down
11 changes: 6 additions & 5 deletions docs/get_started/whats_new.md → docs/whats_new.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: "What's New"
icon: lucide/newspaper
---

Expand Down Expand Up @@ -83,7 +84,7 @@ print(all_specific_result.model_results)

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.

![img.png](../images/visualizations/hf_benchmark.png)
![img.png](images/visualizations/hf_benchmark.png)

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

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

Added vLLM support. While it is currently not the reference implementation for any models it allows you to run comparisons on performance and throughput
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)
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)

## New in v2.6

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

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

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

#### Better support for loading and comparing results

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ markdown_extensions:
nav:
- Get Started:
- index.md
- Installation: installation.md
- installation.md
- whats_new.md
- Usage:
- Get Started: get_started/usage/get_started.md
Expand Down
Loading