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 and Vizualisation run

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

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.5.0.tar.gz (12.6 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.5.0-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: retriever_search-0.5.0.tar.gz
  • Upload date:
  • Size: 12.6 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.5.0.tar.gz
Algorithm Hash digest
SHA256 c2b1aab60fbcb05efae79aa90491ab9f3690f351569332cb668c99a69d06cf69
MD5 a103999e76740a42ae60d642bb71278e
BLAKE2b-256 768de340ebd8aac68f689e974090d78b6669c455ef5feb985ab29bf7cc22fe46

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for retriever_search-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a4e5cc8f4e915115c2ad461fd3760ce849b4dc76a5bec2c4ccd634ba34d24de7
MD5 297cb6598368cd38197f9c47222d98a6
BLAKE2b-256 0a809a271639c0726147e3f44a00283a9bf4d6dad2bf604f5d73942ebe21e799

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