ehartford commited on
Commit
eec4879
·
verified ·
1 Parent(s): 88c4dc1

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +122 -0
README.md ADDED
@@ -0,0 +1,122 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: other
3
+ license_name: qwen-research
4
+ license_link: https://huggingface.co/Qwen/Qwen2.5-3B/blob/main/LICENSE
5
+ datasets:
6
+ - OpenCoder-LLM/opc-sft-stage1
7
+ - OpenCoder-LLM/opc-sft-stage2
8
+ - microsoft/orca-agentinstruct-1M-v1
9
+ - microsoft/orca-math-word-problems-200k
10
+ - NousResearch/hermes-function-calling-v1
11
+ - AI-MO/NuminaMath-CoT
12
+ - AI-MO/NuminaMath-TIR
13
+ - allenai/tulu-3-sft-mixture
14
+ - cognitivecomputations/dolphin-coder
15
+ - HuggingFaceTB/smoltalk
16
+ - cognitivecomputations/samantha-data
17
+ - m-a-p/CodeFeedback-Filtered-Instruction
18
+ - m-a-p/Code-Feedback
19
+ language:
20
+ - en
21
+ base_model:
22
+ - Qwen/Qwen2.5-3B
23
+ ---
24
+
25
+ # Dolphin 3.0 Qwen 2.5 3B 🐬
26
+
27
+ Curated and trained by [Eric Hartford](https://huggingface.co/ehartford), [Ben Gitter](https://huggingface.co/bigstorm), [BlouseJury](https://huggingface.co/BlouseJury) and [Cognitive Computations](https://huggingface.co/cognitivecomputations)
28
+
29
+ [![Discord](https://img.shields.io/discord/1156064224225808488?logo=Discord&logoColor=%23ffffff&label=Discord&link=https%3A%2F%2Fdiscord.gg%2FtCMkMDDHwm)](https://discord.gg/cognitivecomputations)
30
+ Discord: https://discord.gg/cognitivecomputations
31
+
32
+ <img src="https://cdn-uploads.huggingface.co/production/uploads/63111b2d88942700629f5771/cNCs1TBD3FelWCJGkZ3cd.png" width="600" />
33
+
34
+ ## Sponsors
35
+ Our appreciation for the generous sponsors of Dolphin 3.0:
36
+ - [Crusoe Cloud](https://crusoe.ai/) - provided 16x L40s for training and evals
37
+ - [Akash](https://akash.network/) - provided on-demand 8x H100 for training
38
+ - [Lazarus](https://www.lazarusai.com/) - provided 16x H100 for training
39
+ - [Cerebras](https://cerebras.ai/) - provided excellent and fast inference services for data labeling
40
+ - [Andreessen Horowitz](https://a16z.com/) - provided a [grant](https://a16z.com/supporting-the-open-source-ai-community/) that make Dolphin 1.0 possible and enabled me to bootstrap my homelab
41
+
42
+ ## What is Dolphin?
43
+
44
+ Dolphin 3.0 is the next generation of the Dolphin series of instruct-tuned models. Designed to be the ultimate general purpose local model, enabling coding, math, agentic, function calling, and general use cases.
45
+
46
+ Dolphin aims to be a general purpose model, similar to the models behind ChatGPT, Claude, Gemini. But these models present problems for businesses seeking to include AI in their products.
47
+ 1) They maintain control of the system prompt, deprecating and changing things as they wish, often causing software to break.
48
+ 2) They maintain control of the model versions, sometimes changing things silently, or deprecating older models that your business relies on.
49
+ 3) They maintain control of the alignment, and in particular the alignment is one-size-fits all, not tailored to the application.
50
+ 4) They can see all your queries and they can potentially use that data in ways you wouldn't want.
51
+ Dolphin, in contrast, is steerable and gives control to the system owner. You set the system prompt. You decide the alignment. You have control of your data. Dolphin does not impose its ethics or guidelines on you. You are the one who decides the guidelines.
52
+
53
+ Dolphin belongs to YOU, it is your tool, an extension of your will.
54
+ Just as you are personally responsible for what you do with a knife, gun, fire, car, or the internet, you are the creator and originator of any content you generate with Dolphin.
55
+
56
+ https://erichartford.com/uncensored-models
57
+
58
+ ## Chat Template
59
+
60
+ We use ChatML for the chat template.
61
+
62
+ ```
63
+ <|im_start|>system
64
+ You are Dolphin, a helpful AI assistant.<|im_end|>
65
+ <|im_start|>user
66
+ {prompt}<|im_end|>
67
+ <|im_start|>assistant
68
+ ```
69
+
70
+ ## System Prompt
71
+
72
+ In Dolphin, the system prompt is what you use to set the tone and alignment of the responses. You can set a character, a mood, rules for its behavior, and it will try its best to follow them.
73
+
74
+ Make sure to set the system prompt in order to set the tone and guidelines for the responses - Otherwise, it will act in a default way that might not be what you want.
75
+
76
+ Example use of system prompt:
77
+
78
+ ```
79
+ <|im_start|>system
80
+ You are Dolphin, a golang coding assistant. you only code in golang. If the user requests any other programming language, return the solution in golang instead.<|im_end|>
81
+ <|im_start|>user
82
+ Please implement A* using python<|im_end|>
83
+ <|im_start|>assistant
84
+ ```
85
+
86
+ ## Sample Outputs
87
+
88
+ <img src="https://cdn-uploads.huggingface.co/production/uploads/63111b2d88942700629f5771/C-r1X13UBjnUUNb0q2JLV.png" width="600" />
89
+ <img src="https://cdn-uploads.huggingface.co/production/uploads/63111b2d88942700629f5771/4l3KAZiKej2ON7i35PsOa.png" width="600" />
90
+ <img src="https://cdn-uploads.huggingface.co/production/uploads/63111b2d88942700629f5771/1ZalmR66LnwhEQQEFttlu.png" width="600" />
91
+
92
+ ## How to use
93
+
94
+ There are many ways to use a huggingface model including:
95
+ - ollama
96
+ - LM Studio
97
+ - Huggingface Transformers library
98
+ - vllm
99
+ - sglang
100
+ - tgi
101
+
102
+ ## Evals
103
+
104
+ TBD
105
+
106
+ ## Appreciation
107
+
108
+ Respect and thanks to the creators of the open source datasets that were used:
109
+ - [OpenCoder-LLM](https://huggingface.co/OpenCoder-LLM) (opc-sft-stage1, opc-sft-stage2)
110
+ - [microsoft](https://huggingface.co/OpenCoder-LLM) (orca-agentinstruct-1M-v1, orca-math-word-problems-200k)
111
+ - [NousResearch](https://huggingface.co/NousResearch) (hermes-function-calling-v1)
112
+ - [AI-MO](https://huggingface.co/AI-MO) (NuminaMath-CoT, NuminaMath-TIR)
113
+ - [allenai](https://huggingface.co/allenai) (tulu-3-sft-mixture)
114
+ - [HuggingFaceTB](https://huggingface.co/HuggingFaceTB) (smoltalk)
115
+ - [m-a-p](https://huggingface.co/m-a-p) (CodeFeedback-Filtered-Instruction, Code-Feedback)
116
+
117
+ Special thanks to
118
+ - Meta, Qwen, and OpenCoder, who wrote papers and published models that were instrumental in creating Dolphin 3.0.
119
+ - [RLHFlow](https://huggingface.co/RLHFlow) for the excellent reward model used to filter the datasets
120
+ - Deepseek, for the ridiculously fast Deepseek-V3 that we used to augment the data.
121
+
122
+