Local retriever search for your use
Project description
Retriever
To setup your own local search you can now use this repo.
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', 'embedding_model', 'qa_model', 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
- json_save_path -- pass for saving the embeddings to a json can be used later as input_json
- embedding_model -- pick the embedding model you want to we use Spectre model as a default
- qa_model -- you can currently pick between tiny, medium and large
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
Release history Release notifications | RSS feed
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.1.tar.gz
(12.8 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file retriever_search-0.5.1.tar.gz.
File metadata
- Download URL: retriever_search-0.5.1.tar.gz
- Upload date:
- Size: 12.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2cc98b0d4980db9bad96316d751720bf88100e1cf108daa05a056cf85b494b24
|
|
| MD5 |
f56e0f9a41b4dc0619e93f74c49287b5
|
|
| BLAKE2b-256 |
3922ae54efe6532179db5028f3d56388e019337e6a0b4dc7f29f2d5de7858d19
|
File details
Details for the file retriever_search-0.5.1-py3-none-any.whl.
File metadata
- Download URL: retriever_search-0.5.1-py3-none-any.whl
- Upload date:
- Size: 13.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
901dffdada1e93aa87e83adc34b9f095b94e5f9aaa2443a274a124faadeafe56
|
|
| MD5 |
1ff2243e64ff8d1a3c3186f88d7ccc81
|
|
| BLAKE2b-256 |
8ad6e6e7fe591ffe8f1cfe1e633cd73595786457d54ec8e2fdd6036b5c4a2b81
|