Add Sentence Transformers usage
#8
by tomaarsen HF Staff - opened
Hello!
Starting with the next Sentence Transformers release (v6.0.0, planned for around the 18th), this checkpoint loads directly as a multi-vector (ColBERT-style late interaction) retriever through the new MultiVectorEncoder, alongside its existing PyLate usage. This PR adds a Sentence Transformers usage section to the model card and a multi-vector tag. The weights and the existing usage are untouched.
I'd love to feature this model in that release's blog post and documentation, especially once it loads without the revision pin (that is, once this PR is merged).
pip install "sentence-transformers @ git+https://github.com/huggingface/sentence-transformers.git"
from sentence_transformers import MultiVectorEncoder
model = MultiVectorEncoder("LiquidAI/LFM2-ColBERT-350M", revision="refs/pr/8")
query = "Which planet is known as the Red Planet?"
documents = [
"Venus wird oft als Zwilling der Erde bezeichnet, wegen ihrer ähnlichen Größe.",
"Mars, connue pour son apparence rougeâtre, est souvent appelée la planète rouge.",
"Júpiter es el planeta más grande del sistema solar.",
"Saturno è famoso per i suoi bellissimi anelli.",
]
query_embeddings = model.encode_query(query)
document_embeddings = model.encode_document(documents)
print(query_embeddings.shape, document_embeddings[0].shape)
# (32, 128) (17, 128)
# MaxSim late-interaction scoring (higher is more relevant)
scores = model.similarity(query_embeddings, document_embeddings)
print(scores)
# tensor([[30.3632, 30.4892, 30.4024, 30.3004]])
- Tom Aarsen
tomaarsen changed pull request status to open