korvus icon indicating copy to clipboard operation
korvus copied to clipboard

Add documentation

Open DanielDKnudsen opened this issue 1 year ago • 1 comments

There is lacking documentation for the following steps in the setup of korvus in order to run the example scripts:

1. When using a Hugging Face model in a Pipeline, you need to pass a parameter "trust_remote_code": True. Look at below example:

"semantic_search": {"model": "Alibaba-NLP/gte-base-en-v1.5",

Should be:

"semantic_search": {"model": "Alibaba-NLP/gte-base-en-v1.5", "parameters": {"trust_remote_code": True, "token": hf_token}},

2. In order to run any segmentation search you need to create the extension for vectors in the Postgres Database:

$ CREATE EXTENSION IF NOT EXISTS vector;

3. You need to authenticate to Hugging Face in order to use their models in the korvus.OpenSourceAI() component.

This issue I haven't resolved yet

DanielDKnudsen avatar Jul 17 '24 14:07 DanielDKnudsen

Would note this is still an issue, tried following the tutorials and had to search issues to find this.

brickfrog avatar Jan 05 '25 08:01 brickfrog