nielsr HF Staff commited on
Commit
d0f001d
Β·
verified Β·
1 Parent(s): 6ed859d

Fix paper link, add project page and sample usage

Browse files

This PR improves the model card of EvoEmbedding by:
- Fixing the broken/empty paper link and linking it to the arXiv paper.
- Adding the official project page link.
- Adding a "Quick Start" section with sample usage code snippets demonstrating how to use the model as an embedding model and as a reranker, as described in the official GitHub repository.

Files changed (1) hide show
  1. README.md +46 -2
README.md CHANGED
@@ -2,6 +2,7 @@
2
  language:
3
  - en
4
  - zh
 
5
  pipeline_tag: feature-extraction
6
  tags:
7
  - embedding
@@ -9,15 +10,58 @@ tags:
9
  - long-context
10
  - rag
11
  - qwen
12
- license: apache-2.0
13
  ---
14
 
15
  # EvoEmbedding: Evolvable Representations for Long-Context Retrieval and Agentic Memory
16
 
17
- πŸ”— **[GitHub Repository](https://github.com/MiG-NJU/EvoEmbedding)** | πŸ“š **[Training Dataset](https://huggingface.co/datasets/MiG-NJU/EvoTrain-180K)** | πŸ“‘ **[Paper (https://arxiv.org/abs/2606.21649)]()**
18
 
19
  **EvoEmbedding** is a novel embedding model designed for long-context and dynamic retrieval scenarios. Unlike static embedding models that chunk text in isolation, EvoEmbedding maintains a continuously updated **Latent Memory Queue**. This allows it to capture temporal dynamics and generate *context-aware, evolvable embeddings* for precise retrieval in agentic workflows and long-conversations.
20
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
21
  ## πŸ“¦ Model Family
22
 
23
  We provide EvoEmbedding in three sizes based on the Qwen architecture:
 
2
  language:
3
  - en
4
  - zh
5
+ license: apache-2.0
6
  pipeline_tag: feature-extraction
7
  tags:
8
  - embedding
 
10
  - long-context
11
  - rag
12
  - qwen
 
13
  ---
14
 
15
  # EvoEmbedding: Evolvable Representations for Long-Context Retrieval and Agentic Memory
16
 
17
+ πŸ”— **[GitHub Repository](https://github.com/MiG-NJU/EvoEmbedding)** | 🏠 **[Project Page](https://clare-nie.github.io/EvoEmbedding/)** | πŸ“š **[Training Dataset](https://huggingface.co/datasets/MiG-NJU/EvoTrain-180K)** | πŸ“‘ **[Paper](https://arxiv.org/abs/2606.21649)**
18
 
19
  **EvoEmbedding** is a novel embedding model designed for long-context and dynamic retrieval scenarios. Unlike static embedding models that chunk text in isolation, EvoEmbedding maintains a continuously updated **Latent Memory Queue**. This allows it to capture temporal dynamics and generate *context-aware, evolvable embeddings* for precise retrieval in agentic workflows and long-conversations.
20
 
21
+ ## πŸš€ Quick Start
22
+
23
+ To use EvoEmbedding, please clone the [GitHub Repository](https://github.com/MiG-NJU/EvoEmbedding) and install the environment.
24
+
25
+ ### As an Embedding Model
26
+
27
+ ```python
28
+ from model.client import EvoEmbeddingClient
29
+
30
+ client = EvoEmbeddingClient()
31
+
32
+ messages = [
33
+ {"role": "user", "content": "I visited Paris in April."},
34
+ {"role": "assistant", "content": "Noted."},
35
+ {"role": "user", "content": "I bought a new laptop yesterday."},
36
+ {"role": "assistant", "content": "Got it."},
37
+ {"role": "user", "content": "Where did I travel in spring?"},
38
+ ]
39
+
40
+ embeddings = client.encode_messages(messages)
41
+ ```
42
+
43
+ The `messages` input preserves the original dialogue order. `encode_messages` returns normalized embeddings for the history turns and the final query.
44
+
45
+ ### As a Reranker
46
+
47
+ ```python
48
+ candidates = [
49
+ "I visited Paris in April.",
50
+ "I bought a new laptop yesterday.",
51
+ "The meeting was moved to Friday.",
52
+ ]
53
+ query = "Where did I travel in spring?"
54
+
55
+ ranked_candidates, ranked_indices = client.rerank(
56
+ query,
57
+ candidates,
58
+ top_k=1,
59
+ return_indices=True,
60
+ )
61
+ ```
62
+
63
+ The reranker takes a direct list of candidate strings and returns them in relevance order.
64
+
65
  ## πŸ“¦ Model Family
66
 
67
  We provide EvoEmbedding in three sizes based on the Qwen architecture: