ltr-bert-sir-client

Python client for the ltr-bert-sir ELSIE API (sir-elsie Space).

Install

pip install ltr-bert-sir-client

Usage

from ltr_bert_sir_client import SirClient

with SirClient() as sir:
    print(sir.health())
    hits = sir.search({"query": "alice rabbit hole", "mode": "blend", "k": 10})
    print(hits["hits"])

UI demo files:

from ltr_bert_sir_client.ui import write_demo

write_demo("./demo", "http://127.0.0.1:8000")

Local API:

SirClient("http://127.0.0.1:8000")

Development

python3 -m venv .venv
.venv/bin/pip install -e ".[dev]"
.venv/bin/pytest -q
.venv/bin/python -m build

Notebooks

See notebooks/quickstart.py and notebooks/quickstart.ipynb.

Repository layout

ltr-bert-sir-client-py/
├── .github/workflows/ci.yml
├── src/ltr_bert_sir_client/
│   ├── client.py
│   ├── types.py
│   ├── format.py
│   ├── hints.py
│   ├── collections.py
│   └── ui/
├── tests/test_client.py
├── notebooks/
├── pyproject.toml
└── LICENSE

Publish

python -m build
twine upload dist/*

License: Apache-2.0