Update BM25S model

.gitattributes

@@ -33,3 +33,4 @@ 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

README.md

@@ -0,0 +1,91 @@
+---
+language: en
+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.0.1dev0`), an ultra-fast implementation of BM25. It can be used for lexical retrieval tasks.
+
+[BM25S GitHub Repository](https://github.com/xhluca/bm25s)
+
+## Installation
+
+You can install the `bm25s` library with `pip`:
+
+```bash
+pip install "bm25s==0.0.1dev0"
+
+# Include extra dependencies like stemmer
+pip install "bm25s[full]==0.0.1dev0"
+
+# 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("xhluca/bm25s-fiqa-index", revision="main")
+
+# You can retrieve now
+query = "a cat is a feline"
+results = retriever.retrieve(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
+
+# Create a BM25 index and add documents
+retriever = 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",
+]
+corpus_tokens = bm25s.tokenize(corpus)
+retriever.index(corpus_tokens)
+
+token = None  # You can get a token from the Hugging Face website
+retriever.save_to_hub("xhluca/bm25s-fiqa-index", token=token)
+```
+
+
+## Stats
+
+This dataset was created using the following data:
+
+| Statistic | Value |
+| --- | --- |
+| Number of documents | 57638 |
+| Number of tokens | 3626761 |
+| Average tokens per document | 62.923088934383564 |
+
+## 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:00e8ff8573fc4dd54812f105aacba62abbf67b300e71d733f6def01d01f52708
+size 46756874

data.csc.index.npy

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

indices.csc.index.npy

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

indptr.csc.index.npy

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

params.index.json

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