From 39222f037de2f965ca1d10c293b5f16278a4653f Mon Sep 17 00:00:00 2001 From: josc146 Date: Sun, 21 May 2023 17:28:51 +0800 Subject: [PATCH] update readme --- README.md | 81 ++++++++++++++++++++++++++++++++++++++++++++++++++-- README_ZH.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 159 insertions(+), 2 deletions(-) create mode 100644 README_ZH.md diff --git a/README.md b/README.md index 160c2b1..16ddf89 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,80 @@ -# RWKV-Runner +

+ +

-In development +

RWKV Runner

+ +
+ +This project aims to eliminate the barriers of using large language models by automating everything for you. All you need is a lightweight executable program of just a few megabytes. Additionally, this project provides an interface compatible with the OpenAI API, which means that every ChatGPT client is an RWKV client. + +[![license][license-image]][license-url] +[![release][release-image]][release-url] + +English | [简体中文](README_ZH.md) + +[Preview](#Preview) | [Download][download-url] + +[license-image]: http://img.shields.io/badge/license-MIT-blue.svg + +[license-url]: https://github.com/josStorer/RWKV-Runner/blob/master/LICENSE + +[release-image]: https://img.shields.io/github/release/josStorer/RWKV-Runner.svg + +[release-url]: https://github.com/josStorer/RWKV-Runner/releases/latest + +[download-url]: https://github.com/josStorer/RWKV-Runner/releases/download/v1.0.0/RWKV-Runner_windows_x64.exe + +
+ +## Features + +- RWKV model management and one-click startup +- Fully compatible with the OpenAI API, making every ChatGPT client an RWKV client +- Automatic dependency installation, requiring only a lightweight executable program +- User-friendly chat interaction interface included +- Easy-to-understand and operate parameter configuration +- Built-in model conversion tool +- Built-in download management and remote model inspection +- Multilingual localization +- Theme switching +- Automatic updates + +## Todo + +- Model training functionality +- CUDA operator int8 acceleration +- macOS support +- Linux support + +## Related Repositories: + +- RWKV-4-Raven: https://huggingface.co/BlinkDL/rwkv-4-raven/tree/main +- ChatRWKV: https://github.com/BlinkDL/ChatRWKV +- RWKV-LM: https://github.com/BlinkDL/RWKV-LM + +## Preview + +### Homepage + +![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/9d25380a-a17b-443f-b823-86c754ebebf0) + +### Chat + +![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/0e66d5fa-f34a-409f-9cd4-d880815733f3) + +### Configuration + +![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/ad9921fc-7248-40a3-9e18-03445b86e4bf) + +### Model Management + +![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/7c36f15f-3e77-49cd-a16d-99a29f870bdf) + +### Download Management + +![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/32fde30b-11dd-43b9-9667-ad6975be2106) + +### Settings + +![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/e8a0f746-9da7-48e3-b3fc-e1453ac50de2) diff --git a/README_ZH.md b/README_ZH.md new file mode 100644 index 0000000..6a85118 --- /dev/null +++ b/README_ZH.md @@ -0,0 +1,80 @@ +

+ +

+ +

RWKV Runner

+ +
+ +本项目旨在消除大语言模型的使用门槛，全自动为你处理一切，你只需要一个仅仅几MB的可执行程序。此外本项目提供了与OpenAI API兼容的接口，这意味着一切ChatGPT客户端都是RWKV客户端。 + +[![license][license-image]][license-url] +[![release][release-image]][release-url] + +[English](README.md) | 简体中文 + +[预览](#Preview) | [下载][download-url] + +[license-image]: http://img.shields.io/badge/license-MIT-blue.svg + +[license-url]: https://github.com/josStorer/RWKV-Runner/blob/master/LICENSE + +[release-image]: https://img.shields.io/github/release/josStorer/RWKV-Runner.svg + +[release-url]: https://github.com/josStorer/RWKV-Runner/releases/latest + +[download-url]: https://github.com/josStorer/RWKV-Runner/releases/download/v1.0.0/RWKV-Runner_windows_x64.exe + +
+ +## 功能 + +- RWKV模型管理，一键启动 +- 与OpenAI API完全兼容，一切ChatGPT客户端，都是RWKV客户端 +- 全自动依赖安装，你只需要一个轻巧的可执行程序 +- 自带用户友好的聊天交互页面 +- 易于理解和操作的参数配置 +- 内置模型转换工具 +- 内置下载管理和远程模型检视 +- 多语言本地化 +- 主题切换 +- 自动更新 + +## Todo + +- 模型训练功能 +- CUDA算子int8提速 +- macOS支持 +- linux支持 + +## 相关仓库: + +- RWKV-4-Raven: https://huggingface.co/BlinkDL/rwkv-4-raven/tree/main +- ChatRWKV: https://github.com/BlinkDL/ChatRWKV +- RWKV-LM: https://github.com/BlinkDL/RWKV-LM + +## Preview + +### 主页 + +![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/9d25380a-a17b-443f-b823-86c754ebebf0) + +### 聊天 + +![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/0e66d5fa-f34a-409f-9cd4-d880815733f3) + +### 配置 + +![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/ad9921fc-7248-40a3-9e18-03445b86e4bf) + +### 模型管理 + +![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/7c36f15f-3e77-49cd-a16d-99a29f870bdf) + +### 下载管理 + +![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/32fde30b-11dd-43b9-9667-ad6975be2106) + +### 设置 + +![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/e8a0f746-9da7-48e3-b3fc-e1453ac50de2)