Skip to main content

Local retriever search for your use

Project description

Retriever

To setup your own local search you can now use this repo.

GitHub Contributors GitHub Last Commit GitHub Repo Size GitHub Issues GitHub Pull Requests Github License


Install

Recommended to use a virtual environment using venv -

$ python -m venv new_env
$ source new_env/bin/activate

For installing from the github repo -

$ pip install -e .

For installing from the pip -

$ pip install retriever-search

Search server

>>> from retriever_search import search_server
>>> search_server.run_search_server('input_directory', 'input_json', 'json_save_path', device='cpu')

Search parameter meanings

  • input_directory -- The directory holding your files
  • input_json -- pre saved json file from earlier runs can be used for faster loading
  • save_json_path -- pass for saving the embeddings to a json can be used later as input_json

Frontend run

>>> from retriever_search import frontend_app as fp
>>> fp.run_frontend()

Vizualisation run

>>> from retriever_search import dashboard as vs
>>> vs.run_viz_server()

Where to access the frontend

Access via the following URL - http://127.0.0.1:7860 This URL would work for your local setup only

Tickets

1.0.0

  • Add lightweight embedding model support as flag in launcher
  • Remove HTML requirement for plotly visualization
  • Make LDA visualization update
  • Add model quantized

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

retriever_search-0.4.0.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

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

retriever_search-0.4.0-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

Details for the file retriever_search-0.4.0.tar.gz.

File metadata

  • Download URL: retriever_search-0.4.0.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.12

File hashes

Hashes for retriever_search-0.4.0.tar.gz
Algorithm Hash digest
SHA256 6de90fab5188ddfa461bf0b8c5a476a0a7dfb399b5f1b9d1bce00ef3cf1a7b67
MD5 fa03a47060b38c73452d2a85f4cf58e9
BLAKE2b-256 129d120f77ab4d5ae679ac2a179a8c71957b172b99919c1d7f1535987c2113d1

See more details on using hashes here.

File details

Details for the file retriever_search-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for retriever_search-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cb72f86466ddd2c10cb09b6b3fcc375f5899e7fb7eba22f48305029f777ae2ba
MD5 a0a1dac8953dbebcf2b2a26be3eb9d4b
BLAKE2b-256 1893423fe7fcb60004358d20dbb2e3a777dd031d7106f87b49c8b69736f19754

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