Integrate with Sentence Transformers (+ third parties like LlamaIndex/LangChain, etc.) (#1)

- Integrate with Sentence Transformers (c603fc8d0c3322d947d791daffe789508441b381)

1_Pooling/config.json

@@ -0,0 +1,10 @@
+{
+  "word_embedding_dimension": 768,
+  "pooling_mode_cls_token": false,
+  "pooling_mode_mean_tokens": true,
+  "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

@@ -2,6 +2,9 @@
 license: mit
 datasets:
 - rokn/slovlo-dataset-v1
+language:
+- sl
+library_name: sentence-transformers
 ---
 
 The SloVlo (**Slo**venske **Vlo**žitve) project brings purposefully built embeddings and semantic search capabilities to the Slovenian language.
@@ -15,6 +18,44 @@ The code is released in the [slovlo](https://github.com/novoselrok/slovlo) repos
 
 ## Usage
 
+### Via Sentence Transformers
+
+```py
+from sentence_transformers import SentenceTransformer
+import torch
+
+model = SentenceTransformer("rokn/slovlo-v1")
+
+query = "Kam na pohod iz glavnega mesta Slovenije?"
+
+# First, we define the documents we want to search over.
+# In our case, that is a list of destination descriptions.
+documents = [
+    "Triglav je najvišja gora v Sloveniji (2864 m) in simbol slovenske narodne identitete. Pohod je zahteven in običajno traja dva dni. Potrebna je dobra fizična pripravljenost in osnovno znanje plezanja. Priporočena je tudi uporaba vodnika za manj izkušene pohodnike.",
+    "Velika Planina je zelo priljubljena pohodniška destinacija z značilnimi pastirskimi kočami. Pohod je primeren za vse starosti in ponuja čudovite razglede na okoliške gore. Na vrh se lahko povzpnete peš ali z nihalko iz Kamniške Bistrice.",
+    "Bled je znan po kremnih rezinah. Če vas zanima pohod, so pa zraven še Ojstrica, ter Mala in Velika Osojnica.",
+    "Golica je znana po neskončnih poljih narcis v maju. Pohod se začne iz vasi Planina pod Golico in traja približno 2-3 ure. Pot je primerna za vse pohodnike in ponuja lepe razglede na Julijske Alpe in Avstrijo.",
+    "Šmarna Gora je najbolj priljubljena pohodniška destinacija v bližini Ljubljane. Pohod traja približno 1 uro iz Tacna. Na vrhu je koča, kjer lahko uživate v tradicionalni slovenski hrani in lepih razgledih na Ljubljansko kotlino.",
+    "Pohorje je pohodniško območje z različnimi potmi, primernimi za vse starosti in pripravljenosti. Posebej priljubljena je pot do Črnega jezera in Slivniškega jezera. Pozimi je Pohorje tudi priljubljena smučarska destinacija.",
+]
+
+# Embed the documents (destinations).
+document_embeddings = model.encode(documents, prompt_name="document")
+
+# Embed the user query.
+query_embedding = model.encode(query, prompt_name="query")
+
+# Compute dot product between the query and each document.
+similarities = model.similarity(query_embedding, document_embeddings)
+
+# Find the nearest neighbor.
+nearest_index = torch.argmax(similarities).item()
+
+print("Predlog za tvojo naslednjo avanturo:", documents[nearest_index])
+```
+
+### Via Transformers
+
 ```py
 import sys
 from typing import List

config_sentence_transformers.json

@@ -0,0 +1,13 @@
+{
+  "__version__": {
+    "sentence_transformers": "3.0.1",
+    "transformers": "4.41.2",
+    "pytorch": "2.3.1+cu121"
+  },
+  "prompts": {
+    "document": "document: ",
+    "query": "query: "
+  },
+  "default_prompt_name": null,
+  "similarity_fn_name": "cosine"
+}

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
+}