yi-01-ai
commited on
Commit
•
7ed3ea6
1
Parent(s):
e8e2d3c
Auto Sync from git://github.com/01-ai/Yi.git/commit/01a71dc55d4be6dd12fce7b1c884affcb9e33285
Browse files
README.md
CHANGED
@@ -92,20 +92,13 @@ pipeline_tag: text-generation
|
|
92 |
- [⛔️ Limitations of chat model](#️-limitations-of-chat-model)
|
93 |
- [🟢 Who can use Yi?](#-who-can-use-yi)
|
94 |
- [🟢 How to use Yi?](#-how-to-use-yi)
|
95 |
-
|
96 |
-
|
97 |
-
|
98 |
-
- [2. Download the model (optional)](#2-download-the-model-optional)
|
99 |
-
- [3. Examples](#3-examples)
|
100 |
-
- [3.1 Use the chat model](#31-use-the-chat-model)
|
101 |
-
- [3.2 Use the base model](#32-use-the-base-model)
|
102 |
-
- [3.3 Finetune from the base model](#33-finetune-from-the-base-model)
|
103 |
-
- [3.4 Quantization](#34-quantization)
|
104 |
-
- [GPT-Q](#gpt-q)
|
105 |
-
- [AWQ](#awq)
|
106 |
- [🟢 Misc.](#-misc)
|
107 |
-
|
108 |
-
|
|
|
109 |
|
110 |
</details>
|
111 |
|
@@ -236,6 +229,7 @@ Yi has a comprehensive ecosystem, offering a range of tools, services, and model
|
|
236 |
- [🔗 Serving](#-serving)
|
237 |
- [⚙️ Quantitation](#️-quantitation)
|
238 |
- [🛠️ Fine-tuning](#️-fine-tuning)
|
|
|
239 |
|
240 |
### 💦 Upstream
|
241 |
|
@@ -296,8 +290,11 @@ If you're seeking to explore the diverse capabilities within Yi's thriving famil
|
|
296 |
|
297 |
- [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.
|
298 |
|
299 |
-
|
|
|
|
|
300 |
|
|
|
301 |
|
302 |
## 📌 Benchmarks
|
303 |
|
@@ -411,6 +408,14 @@ Everyone! 🙌 ✅
|
|
411 |
|
412 |
# 🟢 How to use Yi?
|
413 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
414 |
[1. Prepare development environment](#1-prepare-development-environment)
|
415 |
<br>[2. Download the model](#2-download-the-model-optional)
|
416 |
<br>[3. Examples](#3-examples)
|
@@ -600,6 +605,12 @@ For more detailed explanation, please read the [doc](https://github.com/01-ai/Yi
|
|
600 |
|
601 |
# 🟢 Misc.
|
602 |
|
|
|
|
|
|
|
|
|
|
|
|
|
603 |
### 📡 Disclaimer
|
604 |
|
605 |
We use data compliance checking algorithms during the training process, to
|
|
|
92 |
- [⛔️ Limitations of chat model](#️-limitations-of-chat-model)
|
93 |
- [🟢 Who can use Yi?](#-who-can-use-yi)
|
94 |
- [🟢 How to use Yi?](#-how-to-use-yi)
|
95 |
+
- [Quick start](#quick-start)
|
96 |
+
- [Deployment](TBD-absolute-path)
|
97 |
+
- [Learning hub](TBD-absolute-path)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
98 |
- [🟢 Misc.](#-misc)
|
99 |
+
- [Ackknowledgements](#acknowledgments)
|
100 |
+
- [📡 Disclaimer](#-disclaimer)
|
101 |
+
- [🪪 License](#-license)
|
102 |
|
103 |
</details>
|
104 |
|
|
|
229 |
- [🔗 Serving](#-serving)
|
230 |
- [⚙️ Quantitation](#️-quantitation)
|
231 |
- [🛠️ Fine-tuning](#️-fine-tuning)
|
232 |
+
- [API](#api)
|
233 |
|
234 |
### 💦 Upstream
|
235 |
|
|
|
290 |
|
291 |
- [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.
|
292 |
|
293 |
+
#### API
|
294 |
+
|
295 |
+
- [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.
|
296 |
|
297 |
+
<div align="right"> [ <a href="#building-the-next-generation-of-open-source-and-bilingual-llms">Back to top ⬆️ </a> ] </div>
|
298 |
|
299 |
## 📌 Benchmarks
|
300 |
|
|
|
408 |
|
409 |
# 🟢 How to use Yi?
|
410 |
|
411 |
+
- [Quick start](#quick-start)
|
412 |
+
|
413 |
+
- [Deployment](TBD-absolute-path)
|
414 |
+
|
415 |
+
- [Learning hub](TBD-absolute-path)
|
416 |
+
|
417 |
+
## Quick start
|
418 |
+
|
419 |
[1. Prepare development environment](#1-prepare-development-environment)
|
420 |
<br>[2. Download the model](#2-download-the-model-optional)
|
421 |
<br>[3. Examples](#3-examples)
|
|
|
605 |
|
606 |
# 🟢 Misc.
|
607 |
|
608 |
+
### Acknowledgments
|
609 |
+
|
610 |
+
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.
|
611 |
+
|
612 |
+
<div align="right"> [ <a href="#building-the-next-generation-of-open-source-and-bilingual-llms">Back to top ⬆️ </a> ] </div>
|
613 |
+
|
614 |
### 📡 Disclaimer
|
615 |
|
616 |
We use data compliance checking algorithms during the training process, to
|