localretriever

A simple Python package


License
MIT
Install
pip install localretriever==0.0.4

Documentation

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

>>> from retriever_search import search_server
>>> from retriever_search import frontend_app as fp
>>> fp.run_frontend()
>>> search_server.run_search_server('path_to_folder', 'save_json_path', device='cpu')

Vizualisation run

Currently run from the git repo

$ cd retriever
>>> from retriever_search import viz_server 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