Skip to content

Commit 7892d9b

Browse files
authored
docs: Update main readme (#361)
1 parent 94cbc1b commit 7892d9b

1 file changed

Lines changed: 5 additions & 34 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,6 @@
66

77

88

9-
<div align="center">
10-
<h2>
11-
<a href="https://huggingface.co/minishlab"><strong>🤗 Models</strong></a> |
12-
<a href="https://minish.ai/packages/model2vec/introduction"><strong>📖 Docs</strong></a> |
13-
<a href="https://github.com/MinishLab/model2vec/blob/main/results/README.md"><strong>🏆 Results</strong></a> |
14-
<a href="https://github.com/MinishLab/model2vec/tree/main/tutorials"><strong>📚 Tutorials</strong></a> |
15-
<a href="https://minish.ai/blog"><strong>🌐 Blog</strong></a>
16-
</div>
17-
189
<div align="center">
1910
<h2>
2011
<a href="https://pypi.org/project/model2vec/"><img src="https://img.shields.io/pypi/v/model2vec?color=%23007ec6&label=pypi%20package" alt="Package version"></a>
@@ -31,24 +22,17 @@
3122
<a href="https://github.com/MinishLab/model2vec/blob/main/LICENSE">
3223
<img src="https://img.shields.io/badge/license-MIT-green" alt="License - MIT">
3324
</a>
34-
<a href="https://github.com/MinishLab/model2vec/stargazers">
35-
<img src="https://img.shields.io/github/stars/minishlab/model2vec.svg" alt=Stars">
36-
</a>
37-
</h2>
38-
</div>
25+
</h2>
3926

4027

4128

29+
[Quickstart](#quickstart) • [Main Features](#main-features) • [Model List](#model-list) • [Results](#results)
30+
</div>
4231

4332

44-
Model2Vec is a technique to turn any sentence transformer into a small, fast static embedding model. Model2Vec reduces model size by a factor up to 50 and makes models up to 500 times faster, with a small drop in performance. Our [best model](https://huggingface.co/minishlab/potion-base-32M) is the most performant static embedding model in the world. See our [results](results/README.md), read our [docs](https://minish.ai/packages/model2vec/introduction), or dive in to see how it works.
4533

46-
<div align="center">
47-
<h3>
34+
Model2Vec is a technique to turn any sentence transformer into a small, fast static embedding model. Model2Vec reduces model size by a factor up to 50 and makes models up to 500 times faster, with a small drop in performance. Our [best model](https://huggingface.co/minishlab/potion-base-32M) is the most performant static embedding model in the world. See our [results](results/README.md), read our [docs](https://minish.ai/packages/model2vec/introduction), or dive in to see how it works.
4835

49-
[Quickstart](#quickstart) • [Updates & Announcements](#updates--announcements) • [Main Features](#main-features) • [Model List](#model-list)
50-
</h3>
51-
</div>
5236

5337
## Quickstart
5438

@@ -118,17 +102,6 @@ classification_report = classifier.evaluate(ds["test"]["text"], ds["test"]["labe
118102

119103
For advanced usage, see our [training docs](https://minish.ai/packages/model2vec/training).
120104

121-
## Updates & Announcements
122-
123-
- **23/05/2025**: We released [potion-multilingual-128M](https://huggingface.co/minishlab/potion-multilingual-128M), a multilingual model trained on 101 languages. It is the best performing static embedding model for multilingual tasks, and is capable of generating embeddings for any text in any language. The results can be found in our [results](results/README.md#mmteb-results-multilingual) section.
124-
125-
- **01/05/2025**: We released backend support for `BPE` and `Unigram` tokenizers, along with quantization and dimensionality reduction. New Model2Vec models are now 50% of the original models size, and can be quantized to int8 to be 25% of the size, without loss of performance.
126-
127-
- **12/02/2025**: We released **Model2Vec training**, allowing you to fine-tune your own classification models on top of Model2Vec models. Find out more in our [training documentation](https://github.com/MinishLab/model2vec/blob/main/model2vec/train/README.md) and [results](results/README.md#training-results).
128-
129-
- **30/01/2025**: We released two new models: [potion-base-32M](https://huggingface.co/minishlab/potion-base-32M) and [potion-retrieval-32M](https://huggingface.co/minishlab/potion-retrieval-32M). [potion-base-32M](https://huggingface.co/minishlab/potion-base-32M) is our most performant model to date, using a larger vocabulary and higher dimensions. [potion-retrieval-32M](https://huggingface.co/minishlab/potion-retrieval-32M) is a finetune of [potion-base-32M](https://huggingface.co/minishlab/potion-base-32M) that is optimized for retrieval tasks, and is the best performing static retrieval model currently available.
130-
131-
- **30/10/2024**: We released three new models: [potion-base-8M](https://huggingface.co/minishlab/potion-base-8M), [potion-base-4M](https://huggingface.co/minishlab/potion-base-4M), and [potion-base-2M](https://huggingface.co/minishlab/potion-base-2M). These models are trained using [Tokenlearn](https://github.com/MinishLab/tokenlearn). Find out more in our [blog post](https://minishlab.github.io/tokenlearn_blogpost/). NOTE: for users of any of our old English M2V models, we recommend switching to these new models as they [perform better on all tasks](https://github.com/MinishLab/model2vec/tree/main/results).
132105

133106
## Main Features
134107

@@ -164,9 +137,7 @@ We provide a number of models that can be used out of the box. These models are
164137
| [potion-multilingual-128M](https://huggingface.co/minishlab/potion-multilingual-128M) | Multilingual | [bge-m3](https://huggingface.co/BAAI/bge-m3) | 128M | General |
165138
| [potion-retrieval-32M](https://huggingface.co/minishlab/potion-retrieval-32M) | English | [bge-base-en-v1.5](https://huggingface.co/BAAI/bge-base-en-v1.5) | 32.3M | Retrieval |
166139
| [potion-base-8M](https://huggingface.co/minishlab/potion-base-8M) | English | [bge-base-en-v1.5](https://huggingface.co/BAAI/bge-base-en-v1.5) | 7.5M | General |
167-
| [potion-base-4M](https://huggingface.co/minishlab/potion-base-4M) | English | [bge-base-en-v1.5](https://huggingface.co/BAAI/bge-base-en-v1.5) | 3.7M | General |
168-
| [potion-base-2M](https://huggingface.co/minishlab/potion-base-2M) | English | [bge-base-en-v1.5](https://huggingface.co/BAAI/bge-base-en-v1.5) | 1.8M | General |
169-
140+
| [potion-code-16M-v2](https://huggingface.co/minishlab/potion-code-16M-v2) | Code | [CodeRankEmbed](https://huggingface.co/nomic-ai/CodeRankEmbed) | 16.2M | Code |
170141

171142

172143

0 commit comments

Comments
 (0)