Update README with LightOn logo, BEIR scores, and improved documentation

README.md

@@ -6,23 +6,44 @@ tags:
 - dense
 pipeline_tag: sentence-similarity
 library_name: sentence-transformers
+license: apache-2.0
+language:
+- en
 ---
 
-# SentenceTransformer
+<p align="center">
+<img src="https://cdn-avatars.huggingface.co/v1/production/uploads/1651597775471-62715572ab9243b5d40cbb1d.png" alt="LightOn" width="120">
+</p>
 
-This is a [sentence-transformers](https://www.SBERT.net) model trained. It maps sentences & paragraphs to a 768-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more.
+<h1 align="center">DenseOn</h1>
+
+<h3 align="center">State-of-the-Art Dense Retrieval Model by LightOn</h3>
+
+<p align="center">
+<a href="https://huggingface.co/lightonai/DenseOn">DenseOn</a> |
+<a href="https://huggingface.co/lightonai/LateOn">LateOn</a> |
+<a href="https://github.com/lightonai/pylate">PyLate</a> |
+<a href="https://github.com/lightonai/fast-plaid">FastPLAID</a>
+</p>
+
+---
+
+**DenseOn** is a dense (single-vector) retrieval model built on ModernBERT (149M parameters), trained by [LightOn](https://lighton.ai). It encodes queries and documents independently using cosine similarity with `query:`/`document:` prefixes and CLS pooling.
+
+DenseOn achieves **56.75** average NDCG@10 on BEIR (14 datasets) and **57.71** on decontaminated BEIR (12 datasets), topping all base-size dense models and outperforming models up to 4x larger. See our [blog post](TODO) for full results and analysis.
 
 ## Model Details
 
 ### Model Description
 - **Model Type:** Sentence Transformer
-<!-- - **Base model:** [Unknown](https://huggingface.co/unknown) -->
+- **Base model:** [ModernBERT-base](https://huggingface.co/answerdotai/ModernBERT-base) (149M parameters)
 - **Maximum Sequence Length:** 512 tokens
 - **Output Dimensionality:** 768 dimensions
 - **Similarity Function:** Cosine Similarity
-<!-- - **Training Dataset:** Unknown -->
-<!-- - **Language:** Unknown -->
-<!-- - **License:** Unknown -->
+- **Pooling:** CLS token
+- **Prompts:** `query:` for queries, `document:` for documents
+- **Language:** English
+- **License:** Apache 2.0
 
 ### Model Sources
 
@@ -53,63 +74,37 @@ Then you can load this model and run inference.
 ```python
 from sentence_transformers import SentenceTransformer
 
-# Download from the 🤗 Hub
-model = SentenceTransformer("lightonai/LateOn-supervised")
+# Download from the Hub
+model = SentenceTransformer("lightonai/DenseOn")
+
 # Run inference
 queries = [
     "Which planet is known as the Red Planet?",
 ]
 documents = [
     "Venus is often called Earth's twin because of its similar size and proximity.",
-    'Mars, known for its reddish appearance, is often referred to as the Red Planet.',
-    'Saturn, famous for its rings, is sometimes mistaken for the Red Planet.',
+    "Mars, known for its reddish appearance, is often referred to as the Red Planet.",
+    "Saturn, famous for its rings, is sometimes mistaken for the Red Planet.",
 ]
-query_embeddings = model.encode_query(queries)
-document_embeddings = model.encode_document(documents)
+
+query_embeddings = model.encode(queries, prompt_name="query")
+document_embeddings = model.encode(documents, prompt_name="document")
 print(query_embeddings.shape, document_embeddings.shape)
 # [1, 768] [3, 768]
 
 # Get the similarity scores for the embeddings
 similarities = model.similarity(query_embeddings, document_embeddings)
 print(similarities)
-# tensor([[0.2046, 0.5422, 0.4971]])
 ```
 
-<!--
-### Direct Usage (Transformers)
-
-<details><summary>Click to see the direct usage in Transformers</summary>
-
-</details>
--->
-
-<!--
-### Downstream Usage (Sentence Transformers)
-
-You can finetune this model on your own dataset.
-
-<details><summary>Click to expand</summary>
+## Related Models
 
-</details>
--->
-
-<!--
-### Out-of-Scope Use
-
-*List how the model may foreseeably be misused and address what users ought not to do with the model.*
--->
-
-<!--
-## Bias, Risks and Limitations
-
-*What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
--->
-
-<!--
-### Recommendations
-
-*What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
--->
+| Model | Description | Link |
+|-------|-------------|------|
+| **DenseOn** | Supervised dense model (this model) | [lightonai/DenseOn](https://huggingface.co/lightonai/DenseOn) |
+| **DenseOn-unsupervised** | Pre-training-only checkpoint | [lightonai/DenseOn-unsupervised](https://huggingface.co/lightonai/DenseOn-unsupervised) |
+| **LateOn** | Supervised ColBERT model | [lightonai/LateOn](https://huggingface.co/lightonai/LateOn) |
+| **LateOn-unsupervised** | Pre-training-only checkpoint | [lightonai/LateOn-unsupervised](https://huggingface.co/lightonai/LateOn-unsupervised) |
 
 ## Training Details
 
@@ -126,20 +121,11 @@ You can finetune this model on your own dataset.
 
 ### BibTeX
 
-<!--
-## Glossary
-
-*Clearly define terms in order to be accessible across audiences.*
--->
-
-<!--
-## Model Card Authors
-
-*Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
--->
-
-<!--
-## Model Card Contact
-
-*Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
--->
+```bibtex
+@inproceedings{chaffin2025pylate,
+  title={PyLate: Flexible Training and Retrieval for Late Interaction Models},
+  author={Chaffin, Antoine and Sourty, Raphael},
+  booktitle={Proceedings of CIKM},
+  year={2025}
+}
+```