Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/OpenBuddy/OpenBuddy

Open Multilingual Chatbot for Everyone
https://github.com/OpenBuddy/OpenBuddy

Last synced: 3 months ago
JSON representation

Open Multilingual Chatbot for Everyone

Awesome Lists containing this project

README 

        
# OpenBuddy - Open Multilingual Chatbot for Everyone





  




[中文](README.zh.md) | [English](README.md)



微信公众号、微信群：






搜索“**开源智友**”，关注公众号并发送“加群”即可获得微信群邀请、参与新模型内测等活动



欢迎关注我们的 ModelScope 社区，体验精选模型的高速下载和一键部署：



https://modelscope.cn/organization/OpenBuddy



Website: [https://openbuddy.ai](https://openbuddy.ai)



GitHub: [https://github.com/OpenBuddy/OpenBuddy](https://github.com/OpenBuddy/OpenBuddy)



Huggingface: https://huggingface.co/OpenBuddy



![Demo](media/demo.png)



OpenBuddy is a powerful open multilingual chatbot model aimed at global users, emphasizing conversational AI and seamless multilingual support for English, Chinese, and other languages.



Built upon Tii's Falcon model and Facebook's LLaMA model, OpenBuddy is fine-tuned to include an extended vocabulary, additional common characters, and enhanced token embeddings. By leveraging these improvements and multi-turn dialogue datasets, OpenBuddy offers a robust model capable of answering questions and performing translation tasks across various languages.



Our mission with OpenBuddy is to provide a free, open, and offline-capable AI model that operates on users' devices, irrespective of their language or cultural background. We strive to empower individuals worldwide to access and benefit from AI technology.



## Online Demo



Currently, the OpenBuddy demo is available on our Discord server. Please join our Discord server to try it out!



Discord: [![Discord](https://img.shields.io/discord/1100710961549168640?color=blueviolet&label=Discord)](https://discord.gg/6fU2s9cGjA)



## Key Features



- **Multilingual** conversational AI, Chinese, English, Japanese, Korean, French, Germany and more!

- Enhanced vocabulary and support for common CJK characters

- Fine-tuned with multi-turn dialogue datasets for improved performance

- Various model sizes to suit your needs: 3B, 7B, 13B, 30B, 40B, 65B, 70B and more!

- 3/4/5-bit quantization for CPU deployment via llama.cpp (with slightly reduced output quality)

- Active development plans for future features and improvements



## Future Plans



- Enhancing multilingual performance

- Optimizing model quality post-quantization

- Developing a mechanism to assess content quality, safety, and inference capabilities

- Investigating Reinforcement Learning with Human Feedback (RLHF)

- Exploring the addition of multimodal capabilities for dialogues with image context



## Model Download



OpenBuddy currently offers model downloads on HuggingFace and ModelScope.



More information about downloading the models can be found in the [Models](models.md) page.



## Prompt Format



For models with versions >= 21.1, the prompt format is defined in the model card.



For models < 21.1: refer to: [Legacy Prompt Format](legacy-prompt-format.md)



## Inference with Ollama (recommended for personal users)



Ollama is a platform for locally deploying large models on consumer-grade hardware. It supports various inference methods such as CPU, CUDA, ROCm, and automatically selects the best hardware accelerator based on the actual situation. Ollama supports model quantization deployment, which means that large models can also run on devices with small memory.



Ollama implements one-stop model download, local deployment, and running. After [installing Ollama](https://github.com/ollama/ollama), you can deploy the 4-bit quantized version of the 8B model with just one command:



```sh

ollama run openbuddy/openbuddy-llama3-8b-v21.1-8k

```



More of our models can be found at: https://ollama.com/openbuddy



## High-concurrency Inference using `vllm` in Linux + CUDA GPU environment



Starting form v21, OpenBuddy models have their prompt formats defined in the `tokenizer_config.json` file, allowing for direct deployment using `vllm` to provide an OpenAI-compatible API service.



For more information, please refer to the [vllm documentation](https://docs.vllm.ai/en/latest/serving/openai_compatible_server.html).



`vllm` is more suitable for high concurrency, multiple users, long context and other scenarios. Through technologies such as `FP8 KV Cache`, the concurrency and long text performance can be further improved. `vllm` currently only supports the Linux operating system and usually requires a CUDA GPU.



## Disclaimer



All OpenBuddy models have inherent limitations and may potentially produce outputs that are erroneous, harmful, offensive, or otherwise undesirable. Users should not use these models in critical or high-stakes situations that may lead to personal injury, property damage, or significant losses. Examples of such scenarios include, but are not limited to, the medical field, controlling software and hardware systems that may cause harm, and making important financial or legal decisions.



OpenBuddy is provided "as-is" without any warranty of any kind, either express or implied, including, but not limited to, the implied warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall the authors, contributors, or copyright holders be liable for any claim, damages, or other liabilities, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.



By using OpenBuddy, you agree to these terms and conditions, and acknowledge that you understand the potential risks associated with its use. You also agree to indemnify and hold harmless the authors, contributors, and copyright holders from any claims, damages, or liabilities arising from your use of OpenBuddy.



## License Restrictions



OpenBuddy-LLaMA series models are subject to Meta's licensing agreement. These models are intended for use only by individuals who have obtained approval from Meta and are eligible to download LLaMA. If you have not obtained approval from Meta, you must visit the https://ai.meta.com/llama/ page, read and agree to the model's licensing agreement, submit an application, and wait for approval from Meta before downloading the model from the model page.



For the OpenBuddy-Falcon-7B/40B, OpenBuddy-Mistral, OpenBuddy-Zephyr and OpenBuddy-OpenLLaMA series models, they are released under the Apache 2.0 License. Please refer to the Apache 2.0 License for applicable scope and restrictions.



For other models, they are usually released under the same license as the base model. Please refer to the Model Card for more information.



Regarding the source code related to the OpenBuddy open-source project (including, but not limited to, example code), they are released under the Apache 2.0 License.



## Acknowledgements



We extend our deepest gratitude to the open-source community for their selfless assistance and contributions to the OpenBuddy project.



Firstly, we would like to specifically thank WeiKe Software for their robust support and help in the aspect of model training. We also want to thank [AIOS.club](https://github.com/aios-club) for their invaluable support.



We thank [Mr. Su Jianlin](https://kexue.fm/) for his valuable advice during the model training process. Not only did he provide professional advice, but he also proposed several methods for context expansion, enabling open models to support inference with long context, which has had a profound impact on our work.



Our appreciation goes to [flysnow](https://www.flysnow.org/about/) and [jstzwj](https://github.com/jstzwj). They provided valuable advice during the early stages of model development and extended substantial support and assistance in model inference.



At the same time, we also wish to express our gratitude to camera and other enthusiasts of open language models. Their suggestions played a pivotal role in improving the model.



Once again, we thank everyone who has contributed to the OpenBuddy project. Our success is inseparable from your support and encouragement.