Skip to main content

Helper application for building index files that uses pyserini

Project description

pyserini-indexer

Helper application for building index files that uses pyserini

Prerequisites

  • python 3.9 (pytorch + faiss are only working under this version unfortunaly ☹️ )
  • if you would want to create/search using learnable Sparse indexes (UNICOIL), you would need CUDA support (pyserini requires here CUDA for backend 😞)

Indexing methods:

  • Sparse:
    • BM25 - traditional not-learnable indexing technique
    • UNICOIL - uses LuceneImpact underneath
  • Dense:
    • MINILM_V2 - smallest model available
    • ANCE
    • TCT_COLBERT - biggest (0.5 gb) and provides best results

Backend support

By default all indexing methods use CPU. If you would want to change this behaviour, set environment variable USE_GPU to some value.

Example usage

  1. Create BM25 sparse index directory
python pyserini-indexer BM25 index_input -o tests/indexes/bm25
  1. Create dense index directory
python pyserini-indexer MINILM_V2 index_input -o tests/indexes/minilm_v2

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyserini_indexer-0.2.0.tar.gz (3.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyserini_indexer-0.2.0-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file pyserini_indexer-0.2.0.tar.gz.

File metadata

  • Download URL: pyserini_indexer-0.2.0.tar.gz
  • Upload date:
  • Size: 3.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.6.1 CPython/3.10.10

File hashes

Hashes for pyserini_indexer-0.2.0.tar.gz
Algorithm Hash digest
SHA256 e992b8f8fdb7c87da6b5ae9c05bab4c8785d2fe84b4a669767ec7c3f499688f5
MD5 98fe73373a6bee64b98407956b22efde
BLAKE2b-256 c38cf1c09189249889a5b875fe2fe93001f6479eb8018008ab4f00e890c3171c

See more details on using hashes here.

File details

Details for the file pyserini_indexer-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pyserini_indexer-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 618196bdac97768d13d84e6dcf788c45279910e7b5f872e58d196c99ea5794f8
MD5 a68e54b6377c3ede66dd179e40dec736
BLAKE2b-256 450df1d40e071c732158d401c48cd7e07f000aeaf5622db410ef9a7f5f1a8183

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page