nielsr HF Staff commited on
Commit
b401bb4
·
verified ·
1 Parent(s): 0c5c10f

Improve model card metadata and add license

Browse files

This PR improves the model card by:

- Adding the `library_name` to specify that the model is compatible with the `sentence-transformers` library.
- Ensuring the correct `pipeline_tag` is present for searchability.
- Adding an Apache 2.0 license.

This ensures the model is correctly categorized and discoverable on the Hugging Face Hub.

Files changed (1) hide show
  1. README.md +7 -26
README.md CHANGED
@@ -7,8 +7,9 @@ tags:
7
  - sentence-similarity
8
  - feature-extraction
9
  - generated_from_trainer
10
- # - dataset_size:640000
11
- # - loss:Distillation
 
12
  ---
13
 
14
  # ModernColBERT + InSeNT
@@ -71,13 +72,11 @@ print(f"Shape of first chunk embedding: {embeddings[0][0].shape}") # torch.Size(
71
  ### Model Description
72
  - **Model Type:** Sentence Transformer
73
  - **Base model:** [lightonai/GTE-ModernColBERT-v1](https://huggingface.co/lightonai/GTE-ModernColBERT-v1)
74
- - **Maximum Sequence Length:** tokens
75
  - **Output Dimensionality:** 128 dimensions
76
  - **Similarity Function:** MaxSim
77
- - **Training Dataset:**
78
- - train
79
- <!-- - **Language:** Unknown -->
80
- <!-- - **License:** Unknown -->
81
 
82
  ### Model Sources
83
 
@@ -106,22 +105,4 @@ ColBERT(
106
  primaryClass={cs.IR},
107
  url={https://arxiv.org/abs/2505.24782},
108
  }
109
- ```
110
-
111
- <!--
112
- ## Glossary
113
-
114
- *Clearly define terms in order to be accessible across audiences.*
115
- -->
116
-
117
- <!--
118
- ## Model Card Authors
119
-
120
- *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
121
- -->
122
-
123
- <!--
124
- ## Model Card Contact
125
-
126
- *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
127
- -->
 
7
  - sentence-similarity
8
  - feature-extraction
9
  - generated_from_trainer
10
+ pipeline_tag: text-ranking
11
+ library_name: sentence-transformers
12
+ license: apache-2.0
13
  ---
14
 
15
  # ModernColBERT + InSeNT
 
72
  ### Model Description
73
  - **Model Type:** Sentence Transformer
74
  - **Base model:** [lightonai/GTE-ModernColBERT-v1](https://huggingface.co/lightonai/GTE-ModernColBERT-v1)
75
+ - **Maximum Sequence Length:** 8192 tokens
76
  - **Output Dimensionality:** 128 dimensions
77
  - **Similarity Function:** MaxSim
78
+ - **Training Dataset:** ConTEB
79
+
 
 
80
 
81
  ### Model Sources
82
 
 
105
  primaryClass={cs.IR},
106
  url={https://arxiv.org/abs/2505.24782},
107
  }
108
+ ```