From c23c644fbc068f8b04344a53fd84da4d1519f79c Mon Sep 17 00:00:00 2001 From: josc146 Date: Tue, 6 Jun 2023 23:50:52 +0800 Subject: [PATCH] update readme --- README.md | 22 ++++++++++++++++++++-- README_ZH.md | 22 ++++++++++++++++++++-- 2 files changed, 40 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6dbabf4..30fa787 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,12 @@ compatible with the OpenAI API, which means that every ChatGPT client is an RWKV English | [简体中文](README_ZH.md) +### Install + +[![Windows][Windows-image]][Windows-url] +[![MacOS][MacOS-image]][MacOS-url] +[![Linux][Linux-image]][Linux-url] + [FAQs](https://github.com/josStorer/RWKV-Runner/wiki/FAQs) | [Preview](#Preview) | [Download][download-url] [license-image]: http://img.shields.io/badge/license-MIT-blue.svg @@ -27,6 +33,18 @@ English | [简体中文](README_ZH.md) [download-url]: https://github.com/josStorer/RWKV-Runner/releases +[Windows-image]: https://img.shields.io/badge/-Windows-blue?logo=windows + +[Windows-url]: https://github.com/josStorer/RWKV-Runner/blob/master/build/windows/Readme_Install.txt + +[MacOS-image]: https://img.shields.io/badge/-MacOS-black?logo=apple + +[MacOS-url]: https://github.com/josStorer/RWKV-Runner/blob/master/build/darwin/Readme_Install.txt + +[Linux-image]: https://img.shields.io/badge/-Linux-black?logo=linux + +[Linux-url]: https://github.com/josStorer/RWKV-Runner/blob/master/build/linux/Readme_Install.txt + #### Default configs do not enable custom CUDA kernel acceleration, but I strongly recommend that you enable it and run with int8 precision, which is much faster and consumes much less VRAM. Go to the Configs page and turn on `Use Custom CUDA kernel to Accelerate`. @@ -71,8 +89,8 @@ body.json: - [ ] Model training functionality - [x] CUDA operator int8 acceleration -- [ ] macOS support -- [ ] Linux support +- [x] macOS support +- [x] Linux support - [ ] Local State Cache DB ## Related Repositories: diff --git a/README_ZH.md b/README_ZH.md index af07a0f..a735919 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -14,6 +14,12 @@ API兼容的接口,这意味着一切ChatGPT客户端都是RWKV客户端。 [English](README.md) | 简体中文 +### 安装 + +[![Windows][Windows-image]][Windows-url] +[![MacOS][MacOS-image]][MacOS-url] +[![Linux][Linux-image]][Linux-url] + [视频演示](https://www.bilibili.com/video/BV1hM4y1v76R) | [疑难解答](https://www.bilibili.com/read/cv23921171) | [预览](#Preview) | [下载][download-url] | [懒人包](https://pan.baidu.com/s/1wchIUHgne3gncIiLIeKBEQ?pwd=1111) [license-image]: http://img.shields.io/badge/license-MIT-blue.svg @@ -26,6 +32,18 @@ API兼容的接口,这意味着一切ChatGPT客户端都是RWKV客户端。 [download-url]: https://github.com/josStorer/RWKV-Runner/releases +[Windows-image]: https://img.shields.io/badge/-Windows-blue?logo=windows + +[Windows-url]: https://github.com/josStorer/RWKV-Runner/blob/master/build/windows/Readme_Install.txt + +[MacOS-image]: https://img.shields.io/badge/-MacOS-black?logo=apple + +[MacOS-url]: https://github.com/josStorer/RWKV-Runner/blob/master/build/darwin/Readme_Install.txt + +[Linux-image]: https://img.shields.io/badge/-Linux-black?logo=linux + +[Linux-url]: https://github.com/josStorer/RWKV-Runner/blob/master/build/linux/Readme_Install.txt + #### 注意 目前RWKV中文模型质量一般,推荐使用英文模型体验实际RWKV能力 @@ -71,8 +89,8 @@ body.json: - [ ] 模型训练功能 - [x] CUDA算子int8提速 -- [ ] macOS支持 -- [ ] linux支持 +- [x] macOS支持 +- [x] linux支持 - [ ] 本地状态缓存数据库 ## 相关仓库: