BM25S

https://github.com/xhluca/bm25s

Admin

BM25S is an ultrafast implementation of BM25 in pure Python powered by Numpy, enabling rapid...

Tokens:1,268,772

Snippets:5,650

Trust Score:9.7

License:MIT

Update:2 weeks ago

Show doc for...

Tokens:

Raw

### Interactive user-directory search example

Source: https://github.com/xhluca/bm25s/blob/main/_autodocs/api-reference/cli.md

Example of using the user-directory helpers: install the CLI extra, index a file into the user directory, search with an explicit index, and search with the interactive picker.

```bash
pip install "bm25s[cli]"
bm25 index docs.txt -u -o ml_docs
bm25 search -u -i ml_docs "what is AI?"
bm25 search -u "what is AI?"          # interactive picker
```

--------------------------------

### CLI example workflow: with user directory

Source: https://github.com/xhluca/bm25s/blob/main/README.md

Workflow using the user directory: index to ~/.bm25s/indices/, search by name, or use the interactive picker.

```bash
# Index to user directory
bm25 index docs.txt -u -o ml_docs

# Search from user directory
bm25 search -u -i ml_docs "what is AI?"

# Or use the interactive picker
bm25 search -u "what is AI?"
```

--------------------------------

### Error handling for unknown timer

Source: https://github.com/xhluca/bm25s/blob/main/_autodocs/api-reference/utils-benchmark.md

Example error handling for stopping a timer that was never started. stop() raises ValueError with message 'Timer with name never_started not started.'

```python
from bm25s.utils.benchmark import Timer

t = Timer()
try:
    t.stop("never_started")
except ValueError as e:
    print(e)  # "Timer with name never_started not started."

```

--------------------------------

### Create test index and launch server

Source: https://github.com/xhluca/bm25s/blob/main/README.md

Create a test index and launch the server with it. The example script creates the index at bm25s_indices/nq.

```bash
source .venv/bin/activate
python examples/index_nq.py # creates bm25s_indices/nq
bm25 mcp launch --port 8000 --index-dir ./bm25s_indices/nq
```

Tokens:

Raw