Update README.md

README.md

@@ -26,42 +26,105 @@ tags:
 This model was converted to GGUF format from [`cognitivecomputations/Dolphin3.0-Llama3.1-8B`](https://huggingface.co/cognitivecomputations/Dolphin3.0-Llama3.1-8B) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
 Refer to the [original model card](https://huggingface.co/cognitivecomputations/Dolphin3.0-Llama3.1-8B) for more details on the model.
 
-## Use with llama.cpp
-Install llama.cpp through brew (works on Mac and Linux)
+# Dolphin 3.0 Llama 3.1 8B 🐬
+Part of the [Dolphin 3.0 Collection](https://huggingface.co/collections/cognitivecomputations/dolphin-30-677ab47f73d7ff66743979a3)
 
-```bash
-brew install llama.cpp
+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)
 
-```
-Invoke the llama.cpp server or the CLI.
+[![Discord](https://img.shields.io/discord/1156064224225808488?logo=Discord&logoColor=%23ffffff&label=Discord&link=https%3A%2F%2Fdiscord.gg%2FtCMkMDDHwm)](https://discord.gg/cognitivecomputations)
+Discord: https://discord.gg/cognitivecomputations
 
-### CLI:
-```bash
-llama-cli --hf-repo tinybiggames/Dolphin3.0-Llama3.1-8B-Q4_K_M-GGUF --hf-file dolphin3.0-llama3.1-8b-q4_k_m.gguf -p "The meaning to life and the universe is"
-```
+<img src="https://cdn-uploads.huggingface.co/production/uploads/63111b2d88942700629f5771/cNCs1TBD3FelWCJGkZ3cd.png" width="600" />
 
-### Server:
-```bash
-llama-server --hf-repo tinybiggames/Dolphin3.0-Llama3.1-8B-Q4_K_M-GGUF --hf-file dolphin3.0-llama3.1-8b-q4_k_m.gguf -c 2048
-```
+## Sponsors
+Our appreciation for the generous sponsors of Dolphin 3.0:
+- [Crusoe Cloud](https://crusoe.ai/) - provided 16x L40s for training and evals
+- [Akash](https://akash.network/) - provided on-demand 8x H100 for training
+- [Lazarus](https://www.lazarusai.com/) - provided 16x H100 for training
+- [Cerebras](https://cerebras.ai/) - provided excellent and fast inference services for data labeling
+- [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
 
-Note: You can also use this checkpoint directly through the [usage steps](https://github.com/ggerganov/llama.cpp?tab=readme-ov-file#usage) listed in the Llama.cpp repo as well.
+## What is Dolphin?
 
-Step 1: Clone llama.cpp from GitHub.
-```
-git clone https://github.com/ggerganov/llama.cpp
-```
+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.
 
-Step 2: Move into the llama.cpp folder and build it with `LLAMA_CURL=1` flag along with other hardware-specific flags (for ex: LLAMA_CUDA=1 for Nvidia GPUs on Linux).
-```
-cd llama.cpp && LLAMA_CURL=1 make
-```
+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.
+1) They maintain control of the system prompt, deprecating and changing things as they wish, often causing software to break.
+2) They maintain control of the model versions, sometimes changing things silently, or deprecating older models that your business relies on.
+3) They maintain control of the alignment, and in particular the alignment is one-size-fits all, not tailored to the application.
+4) They can see all your queries and they can potentially use that data in ways you wouldn't want.
+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.
+
+Dolphin belongs to YOU, it is your tool, an extension of your will.
+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.
+
+https://erichartford.com/uncensored-models
+
+## Chat Template
+
+We use ChatML for the chat template.
 
-Step 3: Run inference through the main binary.
 ```
-./llama-cli --hf-repo tinybiggames/Dolphin3.0-Llama3.1-8B-Q4_K_M-GGUF --hf-file dolphin3.0-llama3.1-8b-q4_k_m.gguf -p "The meaning to life and the universe is"
+<|im_start|>system
+You are Dolphin, a helpful AI assistant.<|im_end|>
+<|im_start|>user
+{prompt}<|im_end|>
+<|im_start|>assistant
 ```
-or 
+
+## System Prompt
+
+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.
+
+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.
+
+Example use of system prompt:
+
 ```
-./llama-server --hf-repo tinybiggames/Dolphin3.0-Llama3.1-8B-Q4_K_M-GGUF --hf-file dolphin3.0-llama3.1-8b-q4_k_m.gguf -c 2048
+<|im_start|>system
+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|>
+<|im_start|>user
+Please implement A* using python<|im_end|>
+<|im_start|>assistant
 ```
+
+## Sample Outputs
+
+<img src="https://cdn-uploads.huggingface.co/production/uploads/63111b2d88942700629f5771/C-r1X13UBjnUUNb0q2JLV.png" width="600" />
+<img src="https://cdn-uploads.huggingface.co/production/uploads/63111b2d88942700629f5771/4l3KAZiKej2ON7i35PsOa.png" width="600" />
+<img src="https://cdn-uploads.huggingface.co/production/uploads/63111b2d88942700629f5771/1ZalmR66LnwhEQQEFttlu.png" width="600" />
+
+## How to use
+
+There are many ways to use a huggingface model including:
+- ollama
+- LM Studio
+- Huggingface Transformers library
+- vllm
+- sglang
+- tgi
+
+### ollama
+- [Install ollama](https://ollama.com/download)
+- ```ollama run hf.co/cognitivecomputations/Dolphin3.0-Llama3.1-8B-GGUF:Q4_0```
+- ```/set system <your system prompt>```
+
+## Evals
+
+TBD
+
+## Appreciation
+
+Respect and thanks to the creators of the open source datasets that were used:
+- [OpenCoder-LLM](https://huggingface.co/OpenCoder-LLM) (opc-sft-stage1, opc-sft-stage2)
+- [microsoft](https://huggingface.co/OpenCoder-LLM) (orca-agentinstruct-1M-v1, orca-math-word-problems-200k)
+- [NousResearch](https://huggingface.co/NousResearch) (hermes-function-calling-v1)
+- [AI-MO](https://huggingface.co/AI-MO) (NuminaMath-CoT, NuminaMath-TIR)
+- [allenai](https://huggingface.co/allenai) (tulu-3-sft-mixture)
+- [HuggingFaceTB](https://huggingface.co/HuggingFaceTB) (smoltalk)
+- [m-a-p](https://huggingface.co/m-a-p) (CodeFeedback-Filtered-Instruction, Code-Feedback)
+
+Special thanks to 
+- Meta, Qwen, and OpenCoder, who wrote papers and published models that were instrumental in creating Dolphin 3.0.
+- [RLHFlow](https://huggingface.co/RLHFlow) for the excellent reward model used to filter the datasets
+- Deepseek, for the ridiculously fast Deepseek-V3 that we used to augment the data.