Update README.md

README.md

@@ -1,13 +1,24 @@
-
 ---
 tags:
 - Turkish
 - turkish
+- passage-retrieval
 license: mit
 language:
 - tr
 base_model: ytu-ce-cosmos/turkish-base-bert-uncased
 ---
+# Turkish-ColBERT
+This is a Turkish passage retrieval model based on the [ColBERT](https://doi.org/10.48550/arXiv.2112.01488) architecture.
+
+The [Comos Turkish Base BERT](https://huggingface.co/ytu-ce-cosmos/turkish-base-bert-uncased) model was fine-tuned on 500k triplets (query, positive passage, negative passage) from a Turkish-translated version of the [MS MARCO dataset](https://huggingface.co/datasets/BeIR/msmarco).
+
+#### ⚠ Uncased use requires manual lowercase conversion
+Convert your text to lower case as follows: 
+```python
+text.replace("I", "ı").lower()
+```
+This is due to a [known issue](https://github.com/huggingface/transformers/issues/6680) with the tokenizer.
 
 ## Example Usage
 
@@ -28,11 +39,15 @@ docs = [
     "Nikola Tesla, alternatif akım (AC) sistemini geliştirmiştir. Elektrik mühendisliği alanında devrim niteliğinde çalışmalar yapmıştır. Kablosuz enerji aktarımı üzerine projeleriyle tanınır."
 ]
 
-rag.index(docs, index_name="smapleTest")
+docs = [doc.replace("I", "ı").lower() for doc in docs]
+
+rag.index(docs, index_name="sampleTest")
+
+query = "Birden fazla Nobel Ödülü alan bilim insanı kimdir?"
+query = query.replace("I", "ı").lower()
 
-query = query = "Birden fazla Nobel Ödülü alan bilim insanı kimdir?"
 results = rag.search(query, k= 1)
-print(results[0]['content']) # "Marie Curie, radyoaktivite üzerine yaptığı çalışmalarla bilim dünyasına büyük katkılar sağlamıştır. Polonyum ve radyum elementlerini keşfetmiştir. İki farklı dalda Nobel Ödülü alan ilk kişi olmuştur."
+print(results[0]['content']) # "marie curie, radyoaktivite üzerine yaptığı çalışmalarla bilim dünyasına büyük katkılar sağlamıştır. polonyum ve radyum elementlerini keşfetmiştir. i̇ki farklı dalda nobel ödülü alan ilk kişi olmuştur."
 ```
 
 # Acknowledgments
@@ -49,5 +64,7 @@ print(results[0]['content']) # "Marie Curie, radyoaktivite üzerine yaptığı
 }
 ```
 
-license: mit
-
+### Contact 
+COSMOS AI Research Group, Yildiz Technical University Computer Engineering Department   <br>
+https://cosmos.yildiz.edu.tr/ <br>
+cosmos@yildiz.edu.tr <br>