openbb-chat 0.0.6

Deep learning package to add chat capabilities to OpenBB

OpenBB Chat

Description

OpenBB Chat provides chat capabilities to OpenBB by leveraging the generative potential of LLMs. The chat is implemented following InstructGPT. This repository contains the implementations of the NLP models and the training/inference infraestructure.

Installation

Poetry

# clone project
git clone https://github.com/Dedalo314/openbb-chat
cd openbb-chat

# [OPTIONAL] create conda environment
conda create -n myenv python=3.10
conda activate myenv

# install poetry (change paths as needed)
POETRY_VERSION=1.5.1
POETRY_HOME=/opt/poetry
POETRY_VENV=/opt/poetry-venv
POETRY_CACHE_DIR=/opt/.cache
python3 -m venv $POETRY_VENV \
&& $POETRY_VENV/bin/pip install -U pip setuptools \
&& $POETRY_VENV/bin/pip install poetry==${POETRY_VERSION}

# add poetry to PATH
PATH="${PATH}:${POETRY_VENV}/bin"

poetry install

How to run

Train model with default configuration

# train demo on CPU
poetry run python openbb_chat/train.py trainer=cpu

# train demo on GPU
poetry run python openbb_chat/train.py trainer=gpu

Train model with chosen experiment configuration from configs/experiment/

poetry run python openbb_chat/train.py experiment=experiment_name.yaml

You can override any parameter from command line like this

poetry run python openbb_chat/train.py trainer.max_epochs=20 data.batch_size=64

Released models

The model Griffin-3B-GPTQ has been created as part of this project by quantizing Griffin-3B. In the future, more models will be trained and released as needed.

Sample usage with pre-trained models

In the repository https://github.com/GPTStonks/api openbb-chat is used to perform retrieval-augmented generation (RAG) with OpenBB's official documentation and pre-trained models. In particular, the classifiers modules are used to find the appropriate function in OpenBB and the llms modules are used to complete the function call.

License

The Dockerfile is based on the image nvidia/cuda, which states that the following notice must be included: This software contains source code provided by NVIDIA Corporation.