Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gptstonks/openbb-chat
Chat interface for OpenBB based on a instruct finetuning of a LLM, similar to ChatGPT.
https://github.com/gptstonks/openbb-chat
chatbot finance huggingface investment-analysis llm openbb pytorch
Last synced: 2 months ago
JSON representation
Chat interface for OpenBB based on a instruct finetuning of a LLM, similar to ChatGPT.
- Host: GitHub
- URL: https://github.com/gptstonks/openbb-chat
- Owner: GPTStonks
- Created: 2023-07-16T11:04:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-28T23:22:50.000Z (10 months ago)
- Last Synced: 2024-10-04T00:35:52.877Z (4 months ago)
- Topics: chatbot, finance, huggingface, investment-analysis, llm, openbb, pytorch
- Language: Python
- Homepage:
- Size: 1.23 MB
- Stars: 20
- Watchers: 5
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OpenBB Chat
## Description
OpenBB Chat provides chat capabilities to [OpenBB](https://github.com/OpenBB-finance/OpenBBTerminal) by leveraging the generative potential of LLMs. The chat is implemented following [InstructGPT](https://openai.com/research/instruction-following). This repository contains the implementations of the NLP models and the training/inference infraestructure.
## Installation
#### PDM
```bash
# clone project
git clone https://github.com/Dedalo314/openbb-chat
cd openbb-chat
# install pdm
pip install pdm
# install package
pdm install
```
## How to run
Train model with default configuration
```bash
# train demo on CPU
python openbb_chat/train.py trainer=cpu
# train demo on GPU
python openbb_chat/train.py trainer=gpu
```
Train model with chosen experiment configuration from [configs/experiment/](configs/experiment/)
```bash
python openbb_chat/train.py experiment=experiment_name.yaml
```
You can override any parameter from command line like this
```bash
python openbb_chat/train.py trainer.max_epochs=20 data.batch_size=64
```
## Released models
The model [Griffin-3B-GPTQ](https://huggingface.co/daedalus314/Griffin-3B-GPTQ) has been created as part of this project by quantizing [Griffin-3B](https://huggingface.co/acrastt/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](https://arxiv.org/abs/2005.11401) (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.*