Chinese | English
Welcome to the Yi Cookbook! This is your one-stop resource for everything related to Yi models, featuring tutorials, demos, and comprehensive documentation. Whether you're just starting out or looking to explore advanced use cases, you'll find valuable information here.
- 🔥2024-08-09: Yi Cookbook 1.0 is released, featuring tutorials and examples in both Chinese and English.
| Category | Description | Notebook, Markdown |
|---|---|---|
| infernce, swift | Perform efficient inference with the Yi model using Swift. | Inference_using_swift.ipynb |
| infernce, transformers | Utilize Transformers to rapidly infer the Yi model. | Inference_using_transformers.ipynb |
| infernce, Imdeploy | Experience fast inference with the Yi model through Imdeploy. | Inference_using_lmdeploy.ipynb |
| infernce, vllm | Deploy vllm for quick and efficient inference with the Yi model. | vLLM_Inference_tutorial.ipynb |
| quantization, swift | Learn how to quantize your Yi model using the power of Swift. | swift-yi-quantization.md |
| quantization, autoawq | Explore quantization techniques for the Yi model with autoawq. | autoawq-yi-quantization.md |
| quantization, autogptq | Dive into quantizing the Yi model using the autogptq library. | autogptq-yi-quantization.md |
| fine-tuning, swift | Discover how to fine-tune your own Yi model with Swift for personalized results. | finetune-yi-with-swift.md |
| fine-tuning, LlaMA-Factory | Unlock the potential of fine-tuning your Yi model with the versatile LlaMA-Factory. | finetune-yi-with-llamafactory.md |
| Local Run, ollama | Set up and run the Yi model locally using the convenient ollama framework. | local-ollama.md |
| Local Run, MLX-LM | Explore local execution of the Yi model within the MLX-LM environment. | local-mlx.md |
| Local Run, LM Studio | Get hands-on experience running the Yi model locally using the intuitive LM Studio interface. | local-lm-studio.md |
| Local Run, llama.cpp | Leverage the llama.cpp library to run the Yi model on your local machine. | local-llama.cpp.md |
| RAG, LlamaIndex | Delve into the world of RAG by building a system based on the Yi model and the powerful LlamaIndex library. | yi_rag_llamaindex.ipynb |
| RAG, LangChain | Master the art of building robust RAG systems using LangChain as the backbone for your Yi model integration. | yi_rag_langchain.ipynb |
| function calling | Embark on a journey to implement function calling from the ground up. | function_calling.ipynb |
| function calling, LlamaIndex | Discover the seamless integration of function calling with the Yi model and LlamaIndex. | function_calling_llamaindex.ipynb |
| Category | Description | Notebook, Markdown |
|---|---|---|
| RAG, LlamaIndex | Integrate the Yi(api) model with LlamaIndex to build a powerful RAG system. | yi_rag_llamaindex.ipynb |
| RAG, LangChain | Explore building feature-rich RAG applications by harnessing the capabilities of LangChain with the Yi API. | yi_rag_langchain.ipynb |
| function calling, LlamaIndex | Learn how to effortlessly implement function calling using the Yi model, powered by the intuitive LlamaIndex framework. | function_calling_llamaindex.ipynb |
| Category | Description | Notebook, Markdown |
|---|---|---|
| fine-tuning | Unlock enhanced mathematical and logical abilities by fine-tuning the Yi-1.5-6B-Chat open-source model. | Enhancing the mathematical and logical abilities of Yi-1.5-6B-Chat.md |
| RAG | Construct an intelligent question answering system by combining the strengths of LlamaIndex and the Yi-large model. | Building an Intelligent Question Answering System Based on LlamaIndex and Yi-large.md |
| demo | Witness the capabilities of large models beyond traditional tasks with a demonstration of Yi playing Street Fighter III. | Playing Street Fighter III with Yi large model.md |
| demo | Explore the creative potential of Yi by diving into a mind map generator application. | Building a Mind Map Generator Based on yi-large.md |
| fine-tuning | Maximize your fine-tuning efforts with a comprehensive guide to best practices for the yi-vl model. | Best Practices for yi-vl Fine-tuning.md |
We warmly welcome contributions from the community! Here are some ways you can get involved:
- Report Issues: Found a bug or have a feature suggestion? Please submit it to GitHub Issues.
- Contribute Demo: Pull requests are highly appreciated! Please follow our Contribution Guidelines.