mirror of
https://github.com/QuivrHQ/quivr.git
synced 2024-12-15 09:32:22 +03:00
0559075cd3
This pull request adds a new guide to the documentation that explains how to configure reranking in Quivr. The guide covers the steps to configure the reranking service using the FlashrankRerank library and the Cohere ReRanker. It also provides information on the required environment variables and the default behavior of the Ranker. |
||
|---|---|---|
| .. | ||
| _snippets | ||
| agents | ||
| brains | ||
| configuring | ||
| deployment | ||
| developers | ||
| features | ||
| images | ||
| video | ||
| .gitignore | ||
| contact-us.mdx | ||
| favicon.ico | ||
| favicon.svg | ||
| install.mdx | ||
| intro.mdx | ||
| mint.json | ||
| README.md | ||
| roadmap.mdx | ||
| slackbot.mdx | ||
| tech-design.mdx | ||
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
$ yarn
Local Development
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.