Code Monkey home page Code Monkey logo

arguflow's Introduction

Arguflow

Software suite for deploying semantic search and RAG/no-hallucination LLM-chat over arbitrary data cards/chunks. Contains a server for duplication detection, bookmarks, retrieval, filtering, recommendations, etc. and also white-label'able UI's for search and retrieval-augmented LLM chat. Build, contribute, and stay-tuned!

DocumentationDebate Search DemoRAG Debate Opponent DemoDiscordMatrix

Arguflow

How to contribute

  1. Fork the repository and clone it to your local machine
  2. Create a new branch with a descriptive name: git checkout -b your-branch-name
  3. Make your changes to the README file. Please ensure that your changes are relevant and add value to the project
  4. Test your changes locally to ensure that they do not break anything
  5. Commit your changes with a descriptive commit message: git commit -m "Add descriptive commit message here"
  6. Push your changes to your forked repository: git push origin your-branch-name
  7. Open a pull request to the main repository and describe your changes in the PR description

Self-hosting the API and UI's

We have a full self-hosting guide available on our documentation page here.

Local development

Install apt packages

curl \
gcc \
g++ \
make \
pkg-config \
python3 \
python3-pip \
libpq-dev \
libssl-dev \
openssl \
libreoffice

Install NodeJS and Yarn

You can use the following, but we recommend using NVM and then running yarn --cwd ./vault-nodejs install .

RUN curl -fsSL https://deb.nodesource.com/setup_18.x | bash - && \
    apt-get install -y nodejs && \
    npm install -g yarn && \
    yarn --cwd ./vault-nodejs install

Set rust to nightly

rustup default nightly

Make admin account

Use vault-client to make an account. Get its uuid and set ADMIN_UUID to equal it in your .env

Install python requirements

pip install -r ./vault-python/requirements.txt

How to debug diesel by getting the exact generated SQL

diesel::debug*query::<diesel::pg::Pg, *>(&query);

How to set up the python verification script

  1. virtualenv venv
  2. source venv/bin/activate
  3. pip install -r ./vault-python/requirements.txt

How to get Rust debug level logs

Run export RUST_LOG=debug

Recommended local dev setup

This repository used to solely house the server folder, but has recently been expanded to contain both search and chat. We recommend that you open VSCode for the search and chat folders independently.

Setup env's

cp .env.chat ./chat/.env
cp .env.search ./search/.env
cp ./server/.env.dist ./server/.env

Start docker container services needed for local dev

./convenience -l

Start services for local dev

We know this is bad. Currently, We recommend managing this through tmuux.

cd server
cargo watch -x run
cd search
yarn
yarn dev
cd chat
yarn
yarn dev

arguflow's People

Contributors

amaransen avatar anikdhabal avatar densumesh avatar fastfists avatar skeptrunedev avatar varun2002 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.