Update README.md
Browse files
README.md
CHANGED
|
@@ -1,111 +1,113 @@
|
|
| 1 |
-
<!-- markdownlint-disable first-line-h1 -->
|
| 2 |
-
<!-- markdownlint-disable html -->
|
| 3 |
-
<!-- markdownlint-disable no-duplicate-header -->
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
<
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
| 41 |
-
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
|
| 53 |
-
- **
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
|
| 57 |
-
|
| 58 |
-
|
| 59 |
-
|
| 60 |
-
|
| 61 |
-
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
|
| 65 |
-
- **
|
| 66 |
-
|
| 67 |
-
|
| 68 |
-
|
| 69 |
-
|
| 70 |
-
|
| 71 |
-
|
| 72 |
-
|
| 73 |
-
|
| 74 |
-
|
| 75 |
-
|
| 76 |
-
|
| 77 |
-
|
| 78 |
-
|
| 79 |
-
|
| 80 |
-
|
| 81 |
-
|
| 82 |
-
|
| 83 |
-
|
| 84 |
-
|
| 85 |
-
|
| 86 |
-
|
| 87 |
-
|
|
| 88 |
-
|
| 89 |
-
|
| 90 |
-
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
|
| 94 |
-
|
| 95 |
-
```
|
| 96 |
-
|
| 97 |
-
|
| 98 |
-
|
| 99 |
-
|
| 100 |
-
|
| 101 |
-
|
| 102 |
-
|
| 103 |
-
|
| 104 |
-
|
| 105 |
-
|
| 106 |
-
|
| 107 |
-
|
| 108 |
-
|
| 109 |
-
|
| 110 |
-
|
|
|
|
|
|
|
| 111 |
- Discord: [Join the SousChef AI community](https://discord.gg/souschef-ai)
|
|
|
|
| 1 |
+
<!-- markdownlint-disable first-line-h1 -->
|
| 2 |
+
<!-- markdownlint-disable html -->
|
| 3 |
+
<!-- markdownlint-disable no-duplicate-header -->
|
| 4 |
+
|
| 5 |
+
|
| 6 |
+
|
| 7 |
+
<div align="center">
|
| 8 |
+
<img src="https://github.com/souschef-ai/SousChef/blob/main/assets/logo.svg?raw=true" width="60%" alt="SousChef AI" />
|
| 9 |
+
</div>
|
| 10 |
+
<hr>
|
| 11 |
+
<div align="center" style="line-height: 1;">
|
| 12 |
+
<a href="https://www.chefprotocol.xyz/" target="_blank" style="margin: 2px;">
|
| 13 |
+
<img alt="Homepage" src="https://github.com/souschef-ai/SousChef/blob/main/assets/badge.svg?raw=true" style="display: inline-block; vertical-align: middle;"/>
|
| 14 |
+
</a>
|
| 15 |
+
<a href="https://chat.souschef.ai/" target="_blank" style="margin: 2px;">
|
| 16 |
+
<img alt="Chat" src="https://img.shields.io/badge/Chat-SousChef%20AI-6c5ce7?color=6c5ce7&logoColor=white" style="display: inline-block; vertical-align: middle;"/>
|
| 17 |
+
</a>
|
| 18 |
+
<a href="https://huggingface.co/souschef-ai" target="_blank" style="margin: 2px;">
|
| 19 |
+
<img alt="Hugging Face" src="https://img.shields.io/badge/Hugging%20Face-SousChef%20AI-fbc531?color=fbc531&logoColor=white" style="display: inline-block; vertical-align: middle;"/>
|
| 20 |
+
</a>
|
| 21 |
+
</div>
|
| 22 |
+
|
| 23 |
+
<div align="center" style="line-height: 1;">
|
| 24 |
+
<a href="https://discord.gg/souschef-ai" target="_blank" style="margin: 2px;">
|
| 25 |
+
<img alt="Discord" src="https://img.shields.io/badge/Discord-SousChef%20AI-7289da?logo=discord&logoColor=white&color=7289da" style="display: inline-block; vertical-align: middle;"/>
|
| 26 |
+
</a>
|
| 27 |
+
<a href="https://github.com/souschef-ai/SousChef/blob/main/assets/qr.png?raw=true" target="_blank" style="margin: 2px;">
|
| 28 |
+
<img alt="Wechat" src="https://img.shields.io/badge/WeChat-SousChef%20AI-brightgreen?logo=wechat&logoColor=white" style="display: inline-block; vertical-align: middle;"/>
|
| 29 |
+
</a>
|
| 30 |
+
<a href="https://twitter.com/souschef_ai" target="_blank" style="margin: 2px;">
|
| 31 |
+
<img alt="Twitter Follow" src="https://img.shields.io/badge/Twitter-souschef_ai-1da1f2?logo=x&logoColor=white" style="display: inline-block; vertical-align: middle;"/>
|
| 32 |
+
</a>
|
| 33 |
+
</div>
|
| 34 |
+
|
| 35 |
+
<div align="center" style="line-height: 1;">
|
| 36 |
+
<a href="https://github.com/souschef-ai/SousChef/blob/main/LICENSE-CODE" style="margin: 2px;">
|
| 37 |
+
<img alt="Code License" src="https://img.shields.io/badge/Code_License-MIT-f5c542?color=f5c542" style="display: inline-block; vertical-align: middle;"/>
|
| 38 |
+
</a>
|
| 39 |
+
<a href="https://github.com/souschef-ai/SousChef/blob/main/LICENSE-MODEL" style="margin: 2px;">
|
| 40 |
+
<img alt="Model License" src="https://img.shields.io/badge/Model_License-Open%20RAIL-M-4caf50?color=4caf50" style="display: inline-block; vertical-align: middle;"/>
|
| 41 |
+
</a>
|
| 42 |
+
</div>
|
| 43 |
+
|
| 44 |
+
<p align="center">
|
| 45 |
+
<a href="https://github.com/souschef-ai/SousChef/blob/main/SousChef_Paper.pdf"><b>Whitepaper</b> 📄</a>
|
| 46 |
+
</p>
|
| 47 |
+
|
| 48 |
+
## 1. Introduction
|
| 49 |
+
|
| 50 |
+
SousChef v1 is an open-source AI model designed to assist developers and power users in building, managing, and innovating on the Hyperliquid ecosystem. With state-of-the-art performance across a wide range of benchmarks, SousChef AI is tailored to deliver actionable insights, streamline portfolio management, and generate optimized strategies.
|
| 51 |
+
|
| 52 |
+
### Key Features:
|
| 53 |
+
- **Precision**: Advanced reasoning and decision-making capabilities using cutting-edge training objectives.
|
| 54 |
+
- **Scalability**: Efficient inference on both consumer-grade GPUs and high-performance clusters.
|
| 55 |
+
- **Versatility**: Pretrained for multi-domain tasks, including mathematics, code generation, and portfolio optimization.
|
| 56 |
+
|
| 57 |
+
SousChef v1 is a step towards making Hyperliquid accessible, transparent, and efficient for everyone.
|
| 58 |
+
|
| 59 |
+
---
|
| 60 |
+
|
| 61 |
+
## 2. Model Overview
|
| 62 |
+
|
| 63 |
+
### **Architecture**
|
| 64 |
+
SousChef v1 employs a Hybrid Transformer architecture with:
|
| 65 |
+
- **256 Expert Modules** for specific task optimization.
|
| 66 |
+
- **Multi-Context Analysis** for longer attention spans (up to 128K tokens).
|
| 67 |
+
- **Dynamic Knowledge Fusion**, enabling real-time adaptation to new data.
|
| 68 |
+
|
| 69 |
+
### **Training Methodology**
|
| 70 |
+
1. **Pretraining**: 10 trillion high-quality tokens, covering diverse domains (finance, mathematics, development).
|
| 71 |
+
2. **Fine-tuning**: Reinforcement learning on real-world user scenarios.
|
| 72 |
+
3. **Ethical Constraints**: Integrated Responsible AI License (RAIL-M) to prevent misuse.
|
| 73 |
+
|
| 74 |
+
### **Performance**
|
| 75 |
+
<p align="center">
|
| 76 |
+
<img width="80%" src="assets/benchmark_souschef_v1.png">
|
| 77 |
+
</p>
|
| 78 |
+
|
| 79 |
+
SousChef v1 consistently outperforms comparable models on key benchmarks, demonstrating exceptional performance in code generation, math reasoning, and portfolio strategies.
|
| 80 |
+
|
| 81 |
+
---
|
| 82 |
+
|
| 83 |
+
## 3. Model Downloads
|
| 84 |
+
|
| 85 |
+
<div align="center">
|
| 86 |
+
|
| 87 |
+
| **Model** | **# Parameters** | **Context Length** | **Download** |
|
| 88 |
+
| :-----------: | :--------------: | :----------------: | :------------------------------------: |
|
| 89 |
+
| SousChef-v1 | 250B | 128K | [🤗 HuggingFace](https://huggingface.co/souschef-ai/SousChef-v1) |
|
| 90 |
+
|
| 91 |
+
</div>
|
| 92 |
+
|
| 93 |
+
### Installation
|
| 94 |
+
Clone the repository and install dependencies:
|
| 95 |
+
```bash
|
| 96 |
+
pip install souschef-ai
|
| 97 |
+
```
|
| 98 |
+
|
| 99 |
+
---
|
| 100 |
+
|
| 101 |
+
## 4. License
|
| 102 |
+
|
| 103 |
+
The code and pre-trained weights for SousChef v1 are licensed under:
|
| 104 |
+
- **Code**: MIT License
|
| 105 |
+
- **Model**: Open RAIL-M License
|
| 106 |
+
|
| 107 |
+
---
|
| 108 |
+
|
| 109 |
+
## 5. Contact
|
| 110 |
+
|
| 111 |
+
Questions or feedback? Reach out via:
|
| 112 |
+
- Email: [support@souschef.ai](mailto:support@souschef.ai)
|
| 113 |
- Discord: [Join the SousChef AI community](https://discord.gg/souschef-ai)
|