Add new SentenceTransformer model

1_Pooling/config.json

@@ -0,0 +1,10 @@
+{
+    "word_embedding_dimension": 768,
+    "pooling_mode_cls_token": true,
+    "pooling_mode_mean_tokens": false,
+    "pooling_mode_max_tokens": false,
+    "pooling_mode_mean_sqrt_len_tokens": false,
+    "pooling_mode_weightedmean_tokens": false,
+    "pooling_mode_lasttoken": false,
+    "include_prompt": true
+}

README.md

@@ -1,199 +1,143 @@
 ---
-library_name: transformers
-tags: []
+tags:
+- sentence-transformers
+- sentence-similarity
+- feature-extraction
+- dense
+pipeline_tag: sentence-similarity
+library_name: sentence-transformers
 ---
 
-# Model Card for Model ID
-
-<!-- Provide a quick summary of what the model is/does. -->
-
+# SentenceTransformer
 
+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.
 
 ## Model Details
 
 ### Model Description
+- **Model Type:** Sentence Transformer
+<!-- - **Base model:** [Unknown](https://huggingface.co/unknown) -->
+- **Maximum Sequence Length:** 512 tokens
+- **Output Dimensionality:** 768 dimensions
+- **Similarity Function:** Cosine Similarity
+<!-- - **Training Dataset:** Unknown -->
+<!-- - **Language:** Unknown -->
+<!-- - **License:** Unknown -->
 
-<!-- Provide a longer summary of what this model is. -->
-
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+### Model Sources
 
-### Model Sources [optional]
+- **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
+- **Repository:** [Sentence Transformers on GitHub](https://github.com/UKPLab/sentence-transformers)
+- **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)
 
-<!-- Provide the basic links for the model. -->
+### Full Model Architecture
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+```
+SentenceTransformer(
+  (0): Transformer({'max_seq_length': 512, 'do_lower_case': False, 'architecture': 'KPRModelForBert'})
+  (1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': True, 'pooling_mode_mean_tokens': False, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True})
+)
+```
 
-## Uses
+## Usage
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+### Direct Usage (Sentence Transformers)
 
-### Direct Use
+First install the Sentence Transformers library:
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+```bash
+pip install -U sentence-transformers
+```
 
-[More Information Needed]
+Then you can load this model and run inference.
+```python
+from sentence_transformers import SentenceTransformer
 
-### Downstream Use [optional]
+# Download from the 🤗 Hub
+model = SentenceTransformer("knowledgeable-ai/kpr-bert-base-uncased")
+# Run inference
+sentences = [
+    'The weather is lovely today.',
+    "It's so sunny outside!",
+    'He drove to the stadium.',
+]
+embeddings = model.encode(sentences)
+print(embeddings.shape)
+# [3, 768]
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+# Get the similarity scores for the embeddings
+similarities = model.similarity(embeddings, embeddings)
+print(similarities)
+# tensor([[1.0000, 0.9583, 0.9074],
+#         [0.9583, 1.0000, 0.9121],
+#         [0.9074, 0.9121, 1.0000]])
+```
 
-[More Information Needed]
+<!--
+### Direct Usage (Transformers)
 
-### Out-of-Scope Use
+<details><summary>Click to see the direct usage in Transformers</summary>
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+</details>
+-->
 
-[More Information Needed]
+<!--
+### Downstream Usage (Sentence Transformers)
 
-## Bias, Risks, and Limitations
+You can finetune this model on your own dataset.
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+<details><summary>Click to expand</summary>
 
-[More Information Needed]
+</details>
+-->
 
-### Recommendations
+<!--
+### Out-of-Scope Use
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+*List how the model may foreseeably be misused and address what users ought not to do with the model.*
+-->
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+<!--
+## Bias, Risks and Limitations
 
-## How to Get Started with the Model
+*What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
+-->
 
-Use the code below to get started with the model.
+<!--
+### Recommendations
 
-[More Information Needed]
+*What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
+-->
 
 ## Training Details
 
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
+### Framework Versions
+- Python: 3.10.14
+- Sentence Transformers: 5.2.0.dev0
+- Transformers: 4.55.4
+- PyTorch: 2.4.0+cu121
+- Accelerate: 0.34.2
+- Datasets: 2.16.1
+- Tokenizers: 0.21.4
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+## Citation
 
-[More Information Needed]
+### BibTeX
 
-## More Information [optional]
+<!--
+## Glossary
 
-[More Information Needed]
+*Clearly define terms in order to be accessible across audiences.*
+-->
 
-## Model Card Authors [optional]
+<!--
+## Model Card Authors
 
-[More Information Needed]
+*Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
+-->
 
+<!--
 ## Model Card Contact
 
-[More Information Needed]
+*Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
+-->

config.json

@@ -29,7 +29,7 @@
   "similarity_function": "dot",
   "similarity_temperature": 1.0,
   "torch_dtype": "float32",
-  "transformers_version": "4.55.2",
+  "transformers_version": "4.55.4",
   "type_vocab_size": 2,
   "use_cache": true,
   "use_entity_position_embeddings": true,

config_sentence_transformers.json

@@ -0,0 +1,14 @@
+{
+  "model_type": "SentenceTransformer",
+  "__version__": {
+    "sentence_transformers": "5.2.0.dev0",
+    "transformers": "4.55.4",
+    "pytorch": "2.4.0+cu121"
+  },
+  "prompts": {
+    "query": "",
+    "document": ""
+  },
+  "default_prompt_name": null,
+  "similarity_fn_name": "cosine"
+}

entity_embeddings.npy

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:ac3a7356fc56611d6efb5c426677e5243e56f14a1ced68d1cbfa9143ec9a455f
+oid sha256:bd83489d63bb45008620d90ba274331981546081491cfdd94be5afea9cb1cfea
 size 11126965376

modules.json

@@ -0,0 +1,14 @@
+[
+  {
+    "idx": 0,
+    "name": "0",
+    "path": "",
+    "type": "sentence_transformers.models.Transformer"
+  },
+  {
+    "idx": 1,
+    "name": "1",
+    "path": "1_Pooling",
+    "type": "sentence_transformers.models.Pooling"
+  }
+]

sentence_bert_config.json

@@ -0,0 +1,4 @@
+{
+    "max_seq_length": 512,
+    "do_lower_case": false
+}