AI should be simple, safe, and amazing.
Data Concierge AI (aka Concierge) is an AI system that works ONLY with the data you feed it. Your data, your prompts, everything are local to your instance.
Concierge is a local and modular RAG framework still in alpha.
Built with simplicy and security in mind, it has some features we love -- and hope you do too!
Concierge requires the following to be available:
python (note: for all commands in documentation we will call the executable python. On your system you may need to use python3)Optional:
If you want to use GPU acceleration (Concierge does NOT require this, but it will make responses dramatically faster), you must have the
NVIDIA drivers correctly setup and running. Concierge will not install or make any adjustmetns to your driver configuration.
Note: if you want to use GPU acceleration on a Windows host, you must use WSL2.
More details here:
https://docs.docker.com/desktop/gpu/
Refer to the documentation from NVIDIA for information on how to do this for your OS.
git clone repo or extract zip.
cd concierge go into the cloned project directory.
python install.py to launch the installer.
Answer the questions and then the installer will ask if you are ready to make changes to the system.
Answer "Y" and let the downloading begin!
If install.py did not work, follow these steps to setup your system.
python -m venv . create a python virtual environment in the current directory.
Linux: source ./bin/activate / Windows PowerShell: .\Scripts\Activate.ps1 enter into the virtual environment.
pip install -r requirements.txt install all dependencies.
copy .env.example into a file named .env and set the folder on your computer that will contain the concierge data.
docker compose up -d will load the docker dependencies.
docker compose -f docker-compose-gpu.yml up -d will load the docker dependencies and use the GPU.
From the cloned project directory simply run launch.py.
If the Docker container dependencies aren't found, you will be given the option to launch with CPU or GPU.
If launch.py did not work:
If you are not in the python virtual environment, please enter it by the correct method:
Linux: source ./bin/activate
Windows PowerShell: .\Scripts\Activate.ps1
To start the web UI, run the following command:
python -m shiny run --launch-browser concierge_shiny/app.py
If running for development you can use this command instead:
python -m shiny run --reload --launch-browser concierge_shiny/app.py
or use the Shiny for Python VSCode extension running from concierge_shiny/app.py. At the time of writing we have noticed an issue where the VSCode browser window doesn't automatically refresh and you have to copy/paste the URL from the console into it. Do this is after seeing the log Application startup complete. you still don't see anything in the VSCode browser.
unknown shorthand flag: 'd' in -d and/or you have the docker-compose command instead of docker compose. This indicates that you're using an older version of Docker than we support. The best course of action would be to install the latest version following instructions from here: https://docs.docker.com/engine/install/. However if you're unable to do this, you may be able to get the Concierge Docker requirements running using docker-compose --file ./docker-compose.yml up.NotOpenSSLWarning, as far as we aware you can ignore this warning without issue.Please read our Code of Conduct then our Contribution Guide.