{"id":21574723,"url":"https://github.com/gptstonks/openbb-chat","last_synced_at":"2025-04-10T16:22:49.481Z","repository":{"id":184485893,"uuid":"667014886","full_name":"GPTStonks/openbb-chat","owner":"GPTStonks","description":"Chat interface for OpenBB based on a instruct finetuning of a LLM, similar to ChatGPT.","archived":false,"fork":false,"pushed_at":"2024-03-28T23:22:50.000Z","size":1293,"stargazers_count":23,"open_issues_count":5,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-19T12:39:32.301Z","etag":null,"topics":["chatbot","finance","huggingface","investment-analysis","llm","openbb","pytorch"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GPTStonks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-07-16T11:04:51.000Z","updated_at":"2025-02-06T14:30:52.000Z","dependencies_parsed_at":"2023-10-29T12:26:56.756Z","dependency_job_id":"6bdc72e7-7d70-4dcb-b787-39728ab5f8e5","html_url":"https://github.com/GPTStonks/openbb-chat","commit_stats":null,"previous_names":["gptstonks/openbb-chat"],"tags_count":10,"template":false,"template_full_name":"ashleve/lightning-hydra-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GPTStonks%2Fopenbb-chat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GPTStonks%2Fopenbb-chat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GPTStonks%2Fopenbb-chat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GPTStonks%2Fopenbb-chat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GPTStonks","download_url":"https://codeload.github.com/GPTStonks/openbb-chat/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248252659,"owners_count":21072699,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatbot","finance","huggingface","investment-analysis","llm","openbb","pytorch"],"created_at":"2024-11-24T12:10:51.862Z","updated_at":"2025-04-10T16:22:49.451Z","avatar_url":"https://github.com/GPTStonks.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# OpenBB Chat\n\n\u003cp align=\"center\"\u003e\n  \u003c!-- X Badge --\u003e\n  \u003ca href=\"https://twitter.com/GPTStonks\"\u003e\u003cimg src=\"https://img.shields.io/badge/follow_us-000000?logo=x\u0026logoColor=white\" alt=\"X Follow Us Badge\"\u003e\u003c/a\u003e\n  \u003c!-- Discord Badge --\u003e\n  \u003ca href=\"https://discord.gg/MyDDGuEd\"\u003e\u003cimg src=\"https://img.shields.io/badge/Discord-5865F2?logo=discord\u0026logoColor=white\" alt=\"Discord Badge\"\u003e\u003c/a\u003e\n  \u003c!-- Docker Badge --\u003e\n  \u003ca href=\"https://hub.docker.com/u/gptstonks\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Docker-2496ED?logo=docker\u0026logoColor=white\" alt=\"Docker Badge\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://pytorch.org/get-started/locally/\"\u003e\u003cimg alt=\"PyTorch\" src=\"https://img.shields.io/badge/PyTorch-ee4c2c?logo=pytorch\u0026logoColor=white\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://pytorchlightning.ai/\"\u003e\u003cimg alt=\"Lightning\" src=\"https://img.shields.io/badge/-Lightning-792ee5?logo=pytorchlightning\u0026logoColor=white\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://hydra.cc/\"\u003e\u003cimg alt=\"Config: Hydra\" src=\"https://img.shields.io/badge/Config-Hydra-89b8cd\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://huggingface.co/\"\u003e\u003cimg alt=\"Models: HuggingFace\" src=\"https://img.shields.io/badge/Models-HuggingFace-ffd21e\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003c/div\u003e\n\n## Description\n\nOpenBB 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.\n\n## Installation\n\n#### PDM\n\n```bash\n# clone project\ngit clone https://github.com/Dedalo314/openbb-chat\ncd openbb-chat\n\n# install pdm\npip install pdm\n\n# install package\npdm install\n```\n\n## How to run\n\nTrain model with default configuration\n\n```bash\n# train demo on CPU\npython openbb_chat/train.py trainer=cpu\n\n# train demo on GPU\npython openbb_chat/train.py trainer=gpu\n```\n\nTrain model with chosen experiment configuration from [configs/experiment/](configs/experiment/)\n\n```bash\npython openbb_chat/train.py experiment=experiment_name.yaml\n```\n\nYou can override any parameter from command line like this\n\n```bash\npython openbb_chat/train.py trainer.max_epochs=20 data.batch_size=64\n```\n\n## Released models\n\nThe 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.\n\n## Sample usage with pre-trained models\n\nIn 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.\n\n## License\n\nThe 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.*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgptstonks%2Fopenbb-chat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgptstonks%2Fopenbb-chat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgptstonks%2Fopenbb-chat/lists"}