Update BM25S model

.gitattributes

@@ -33,3 +33,6 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+corpus.jsonl filter=lfs diff=lfs merge=lfs -text
+corpus.mmindex.json filter=lfs diff=lfs merge=lfs -text
+vocab.index.json filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,109 @@
+---
+language: en
+library_name: bm25s
+tags:
+- bm25
+- bm25s
+- retrieval
+- search
+- lexical
+---
+
+# BM25S Index
+
+This is a BM25S index created with the [`bm25s` library](https://github.com/xhluca/bm25s) (version `0.1.7`), an ultra-fast implementation of BM25. It can be used for lexical retrieval tasks.
+
+💻[BM25S GitHub Repository](https://github.com/xhluca/bm25s)\
+🌐[BM25S Homepage](https://bm25s.github.io)
+
+## Installation
+
+You can install the `bm25s` library with `pip`:
+
+```bash
+pip install "bm25s==0.1.7"
+
+# Include extra dependencies like stemmer
+pip install "bm25s[full]==0.1.7"
+
+# For huggingface hub usage
+pip install huggingface_hub
+```
+
+## Loading a `bm25s` index
+
+You can use this index for information retrieval tasks. Here is an example:
+
+```python
+import bm25s
+from bm25s.hf import BM25HF
+
+# Load the index
+retriever = BM25HF.load_from_hub("mteb/index_wikipedia_bm25")
+
+# You can retrieve now
+query = "a cat is a feline"
+results = retriever.retrieve(bm25s.tokenize(query), k=3)
+```
+
+## Saving a `bm25s` index
+
+You can save a `bm25s` index to the Hugging Face Hub. Here is an example:
+
+```python
+import bm25s
+from bm25s.hf import BM25HF
+
+corpus = [
+    "a cat is a feline and likes to purr",
+    "a dog is the human's best friend and loves to play",
+    "a bird is a beautiful animal that can fly",
+    "a fish is a creature that lives in water and swims",
+]
+
+retriever = BM25HF(corpus=corpus)
+retriever.index(bm25s.tokenize(corpus))
+
+token = None  # You can get a token from the Hugging Face website
+retriever.save_to_hub("mteb/index_wikipedia_bm25", token=token)
+```
+
+## Advanced usage
+
+You can leverage more advanced features of the BM25S library during `load_from_hub`:
+
+```python
+# Load corpus and index in memory-map (mmap=True) to reduce memory
+retriever = BM25HF.load_from_hub("mteb/index_wikipedia_bm25", load_corpus=True, mmap=True)
+
+# Load a different branch/revision
+retriever = BM25HF.load_from_hub("mteb/index_wikipedia_bm25", revision="main")
+
+# Change directory where the local files should be downloaded
+retriever = BM25HF.load_from_hub("mteb/index_wikipedia_bm25", local_dir="/path/to/dir")
+
+# Load private repositories with a token:
+retriever = BM25HF.load_from_hub("mteb/index_wikipedia_bm25", token=token)
+```
+
+## Stats
+
+This dataset was created using the following data:
+
+| Statistic | Value |
+| --- | --- |
+| Number of documents | 3811232 |
+| Number of tokens | 438712919 |
+| Average tokens per document | 115.11 |
+
+## Parameters
+
+The index was created with the following parameters:
+
+| Parameter | Value |
+| --- | --- |
+| k1 | `1.5` |
+| b | `0.75` |
+| delta | `0.5` |
+| method | `lucene` |
+| idf method | `lucene` |

corpus.jsonl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:e8229a18852e6b6b4b241ade62a8181d7811ddf1b281e25221e84b3dd0b0bf65
+size 5821785533

corpus.mmindex.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1ad6f8bb6791d785aae732482a33606bcff7981014fbc677b89657d9a1cd080a
+size 41197814

data.csc.index.npy

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:9a18b3c07afb8a58d8df6c75b6d7ad5317d149308678990338b3d6b64141d46b
+size 1754851804

indices.csc.index.npy

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7cc32419d7697092dfacdae5a3ce9e2bbd79b5f2f614e9386a0624c3dc01087f
+size 1754851804

indptr.csc.index.npy

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6056ce965ef854c72c83744cd3aaab3a390b9b32f111683b15b86a2dd55eccf8
+size 11434096

params.index.json

@@ -0,0 +1,11 @@
+{
+    "k1": 1.5,
+    "b": 0.75,
+    "delta": 0.5,
+    "method": "lucene",
+    "idf_method": "lucene",
+    "dtype": "float32",
+    "int_dtype": "int32",
+    "num_docs": 3811232,
+    "version": "0.1.7"
+}

vocab.index.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:75de8daadb78bb341b1de32deae3cfb101f5417c75087e6cbe9a39f66769ef65
+size 56953104