Merge pull request #288 from Anonymitaet/01101

[doc][feat] add docs for hard requirements, learning hub, acknowledgements, etc

README.md

@@ -37,7 +37,11 @@
 </p> 
 
 <p align="center">
-    👋 Join us 💬 <a href="https://github.com/01-ai/Yi/issues/43#issuecomment-1827285245" target="_blank"> WeChat (Chinese) </a>!
+    👋 Join us on 💬 <a href="https://github.com/01-ai/Yi/issues/43#issuecomment-1827285245" target="_blank"> WeChat (Chinese) </a>!
+</p> 
+
+<p align="center">
+    📚 Grow at <a href="TBD-absolute-url"> Yi Learning Hub </a>!
 </p> 
 
 
@@ -69,20 +73,13 @@
     - [⛔️ Limitations of chat model](#️-limitations-of-chat-model)
 - [🟢 Who can use Yi?](#-who-can-use-yi)
 - [🟢 How to use Yi?](#-how-to-use-yi)
-    - [1. Prepare development environment](#1-prepare-development-environment)
-      - [1.1 Docker](#11-docker)
-      - [1.2 Local development environment](#12-local-development-environment)
-    - [2. Download the model (optional)](#2-download-the-model-optional)
-    - [3. Examples](#3-examples)
-      - [3.1 Use the chat model](#31-use-the-chat-model)
-      - [3.2 Use the base model](#32-use-the-base-model)
-      - [3.3 Finetune from the base model](#33-finetune-from-the-base-model)
-      - [3.4 Quantization](#34-quantization)
-        - [GPT-Q](#gpt-q)
-        - [AWQ](#awq)
+  - [Quick start](#quick-start)
+  - [Deployment](TBD-absolute-path)
+  - [Learning hub](TBD-absolute-path)
 - [🟢 Misc.](#-misc)
-    - [📡 Disclaimer](#-disclaimer)
-    - [🪪 License](#-license)
+  - [Ackknowledgements](#acknowledgments)
+  - [📡 Disclaimer](#-disclaimer)
+  - [🪪 License](#-license)
 
 </details>
 
@@ -213,6 +210,7 @@ Yi has a comprehensive ecosystem, offering a range of tools, services, and model
   - [🔗 Serving](#-serving)
   - [⚙️ Quantitation](#️-quantitation)
   - [🛠️ Fine-tuning](#️-fine-tuning)
+  - [API](#api)
 
 ### 💦 Upstream
 
@@ -273,8 +271,11 @@ If you're seeking to explore the diverse capabilities within Yi's thriving famil
 
 - [NousResearch/Nous-Capybara-34B](https://huggingface.co/NousResearch/Nous-Capybara-34B): this model is trained with 200K context length and 3 epochs on the Capybara dataset. 
 
-<div align="right"> [ <a href="#building-the-next-generation-of-open-source-and-bilingual-llms">Back to top ⬆️ </a> ] </div>
+#### API
 
+- [amazing-openai-api](https://github.com/soulteary/amazing-openai-api): this tool converts Yi model APIs into the OpenAI API format out of the box.
+
+<div align="right"> [ <a href="#building-the-next-generation-of-open-source-and-bilingual-llms">Back to top ⬆️ </a> ] </div>
 
 ## 📌 Benchmarks 
 
@@ -388,6 +389,14 @@ Everyone! 🙌 ✅
 
 # 🟢 How to use Yi?
 
+- [Quick start](#quick-start)
+
+- [Deployment](TBD-absolute-path)
+
+- [Learning hub](TBD-absolute-path)
+
+## Quick start
+
 [1. Prepare development environment](#1-prepare-development-environment)
 <br>[2. Download the model](#2-download-the-model-optional)
 <br>[3. Examples](#3-examples)
@@ -577,6 +586,12 @@ For more detailed explanation, please read the [doc](https://github.com/01-ai/Yi
 
 # 🟢 Misc.
 
+### Acknowledgments
+
+A heartfelt thank you to each of you who have made contributions to the Yi community! You have helped Yi not just a project, but a vibrant, growing home for innovation.
+
+<div align="right"> [ <a href="#building-the-next-generation-of-open-source-and-bilingual-llms">Back to top ⬆️ </a> ] </div>
+
 ### 📡 Disclaimer
 
 We use data compliance checking algorithms during the training process, to

docs/deployment.md

@@ -0,0 +1,23 @@
+# Hardware requirements
+
+Before deploying Yi in your environment, make sure your hardware meets the following requirements.
+
+## Chat models
+
+| Model                | Minimum VRAM |        Recommended GPU  Example       |
+|----------------------|--------------|:-------------------------------------:|
+| Yi-6B-Chat           | 15 GB         | RTX 3090 <br> RTX 4090 <br>  A10 <br> A30             |
+| Yi-6B-Chat-4bits     | 4 GB          | RTX 3060 <br>  RTX 4060                     |
+| Yi-6B-Chat-8bits     | 8 GB          | RTX 3070 <br> RTX 4060                     |
+| Yi-34B-Chat          | 72 GB         | 4 x RTX 4090 <br> A800 (80GB)               |
+| Yi-34B-Chat-4bits    | 20 GB         | RTX 3090  <br> RTX 4090 <br> A10 <br> A30 <br> A100(40GB) |
+| Yi-34B-Chat-8bits    | 38 GB         | 2 x RTX 3090  <br> 2 x RTX 4090 <br> A800  (40GB) |
+
+## Base models
+
+| Model                | Minimum VRAM |        Recommended GPU  Example       |
+|----------------------|--------------|:-------------------------------------:|
+| Yi-6B                | 15 GB         | RTX3090 <br> RTX4090 <br> A10 <br> A30               |
+| Yi-6B-200K           | 50 GB         | A800 (80 GB)                            |
+| Yi-34B               | 72 GB         | 4 x RTX 4090 <br> A800 (80 GB)               |
+| Yi-34B-200K          | 200 GB        | 4 x A800 (80 GB)                        |

docs/learning_hub.md

@@ -0,0 +1,19 @@
+# Learning hub
+
+Welcome to the Yi learning hub! 
+
+Whether you're a seasoned developer or a newcomer, you can find a wealth of helpful educational resources to enhance your understanding and skills with Yi models, including insightful blog posts, comprehensive video tutorials, hands-on guides, and more.  
+
+The content you find here has been generously contributed by knowledgeable Yi experts and passionate enthusiasts. We extend our heartfelt gratitude for your invaluable contributions! 
+
+At the same time, we also warmly invite you to join our collaborative effort by contributing to Yi. If you have already made contributions to Yi, please don't hesitate to showcase your remarkable work in the table below.
+
+With all these resources at your fingertips, you're ready to start your exciting journey with Yi. Happy learning! 🥳
+
+## Tutorials
+
+| Type        | Deliverable                                            | Author                  |
+|-------------|--------------------------------------------------------|-------------------------|
+| Blog        | [零一万物模型折腾笔记：官方 Yi-34B 模型基础使用](https://zhuanlan.zhihu.com/p/671387298)         | 苏洋                    |
+| Video       | [只需 24G 显存，用 vllm 跑起来 Yi-34B 中英双语大模型](https://www.bilibili.com/video/BV17t4y1f7Ee/?spm_id_from=333.337.search-card.all.click&vd_source=64a95c92c8c52a184ab3abdf6e8f589a)    | 漆妮妮                  |
+| Video       | [Install Yi 34B Locally - Chinese English Bilingual LLM](https://www.youtube.com/watch?v=CVQvj4Wrh4w&t=476s) | Fahd Mirza              |