qherreros commited on
Commit
86ffa82
·
verified ·
1 Parent(s): 606bdb4

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +92 -0
README.md ADDED
@@ -0,0 +1,92 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model:
3
+ - Qwen/Qwen3-0.6B
4
+ license: cc
5
+ ---
6
+ <br><br>
7
+
8
+ <p align="center">
9
+ <img src="https://huggingface.co/datasets/jinaai/documentation-images/resolve/main/logo.webp" alt="Jina AI: Your Search Foundation, Supercharged!" width="150px">
10
+ </p>
11
+
12
+ ### **jina-embeddings-v5-text-small-clustering**: Clustering-Targeted Embedding Distillation
13
+
14
+ [Blog](https://picsum.photos/200/300) | [Technical Report](https://picsum.photos/200/300) | [API](https://jina.ai/embeddings)
15
+
16
+ ### Model Overview
17
+
18
+ `jina-embeddings-v5-text-small-clustering` is a compact, high-performance text embedding model designed for clustering.
19
+
20
+ It is part of the **jina-embeddings-v5-text** model family, which also includes [jina-embeddings-v5-text-nano](https://huggingface.co/jinaai/jina-embeddings-v5-text-nano), a smaller model for more resource-constrained use cases.
21
+
22
+ Trained using a novel approach that combines distillation with task-specific contrastive losses, `jina-embeddings-v5-text-small-clustering` outperforms existing state-of-the-art models of similar size across diverse embedding benchmarks.
23
+
24
+ | Feature | Value |
25
+ | --- | --- |
26
+ | Parameters | 677M |
27
+ | Supported Tasks | `clustering`|
28
+ | Max Sequence Length | 32768 |
29
+ | Embedding Dimension | 1024 |
30
+ | Matryoshka Dimensions | 32, 64, 128, 256, 512, 768, 1024 |
31
+ | Pooling Strategy | Last-token pooling |
32
+ | Base Model | Qwen/Qwen3-0.6B-Base |
33
+
34
+ ### Training and Evaluation
35
+
36
+ For training details and evaluation results, see our [technical report](https://picsum.photos/200/300).
37
+
38
+ ### Usage
39
+
40
+ <details>
41
+ <summary>Requirements</a></summary>
42
+
43
+ The following Python packages are required:
44
+
45
+ - `transformers>=4.57.0`
46
+ - `torch>=2.8.0`
47
+ - `peft>=0.15.2`
48
+
49
+ ### Optional / Recommended
50
+ - **flash-attention**: Installing [flash-attention](https://github.com/Dao-AILab/flash-attention) is recommended for improved inference speed and efficiency, but not mandatory.
51
+ - **sentence-transformers**: If you want to use the model via the `sentence-transformers` interface, install this package as well.
52
+
53
+ </details>
54
+
55
+ <details>
56
+ <summary>via <a href="https://github.com/vllm-project/vllm">vLLM</a></summary>
57
+
58
+ ```python
59
+ from vllm import LLM
60
+
61
+ # Initialize model
62
+ name = "jinaai/jina-embeddings-v5-text-small-clustering"
63
+ model = LLM(model=name, task="embed", dtype="bfloat16")
64
+
65
+ # Create text prompts
66
+ document1 = "Overview of climate change impacts on coastal cities"
67
+ document1_prompt = f"Document: {document1}"
68
+
69
+ document2 = "The impacts of climate change on large cities"
70
+ document2_prompt = f"Document: {document2}"
71
+
72
+ # Encode all prompts
73
+ prompts = [document1_prompt, document2_prompt]
74
+ outputs = model.encode(prompts, pooling_task="embed")
75
+
76
+
77
+ embed_document1 = outputs[0].outputs.data
78
+ embed_document2 = outputs[1].outputs.data
79
+ ```
80
+
81
+ </details>
82
+
83
+ ### License
84
+
85
+ The model is licensed under CC BY-NC 4.0. For commercial use, please [contact us](link).
86
+
87
+
88
+ ### Citation
89
+
90
+ If you find `jina-embeddings-v5-text-small-clustering` useful in your research, please cite the following paper:
91
+
92
+ [TODO]