Update README.md

README.md

@@ -1,3 +1,100 @@
----
-license: gemma
----
+---
+license: gemma
+datasets:
+- NbAiLab/aurora-sft-2512-filtered
+language:
+- 'no'
+- nb
+- nn
+base_model: NbAiLab/borealis-12b-instruct-preview
+pipeline_tag: image-text-to-text
+library_name: transformers
+tags:
+- conversational
+- instruct
+- experimental
+- llama-cpp
+---
+
+# borealis-12b-instruct-preview
+**Model creator:** [NbAiLab](https://huggingface.co/NbAiLab)<br/>
+**Original model**: [NbAiLab/borealis-12b-instruct-preview](https://huggingface.co/NbAiLab/borealis-12b-instruct-preview)<br/>
+**GGUF quantization:** provided by [NbAiLab](https://huggingface.co/NbAiLab) using `llama.cpp`<br/>
+
+## Available Quantizations
+- Q4_K_M
+- Q8_0
+- BF16
+
+## Special thanks
+🙏 Special thanks to [Georgi Gerganov](https://github.com/ggerganov) and the whole team working on [llama.cpp](https://github.com/ggerganov/llama.cpp/) for making all of this possible.
+
+## Usage Examples
+
+### Q4_K_M
+
+**Ollama:**
+```bash
+ollama run "hf.co/NbAiLab/borealis-12b-instruct-preview-gguf:Q4_K_M"
+```
+
+**LM Studio:**
+```bash
+lms load "NbAiLab/borealis-12b-instruct-preview-gguf/borealis-12b-instruct-preview-Q4_K_M.gguf"
+```
+
+**llama.cpp CLI:**
+```bash
+llama-cli --hf "NbAiLab/borealis-12b-instruct-preview-gguf:Q4_K_M" -p "The meaning to life and the universe is"
+```
+
+**llama.cpp Server:**
+```bash
+llama-server --hf "NbAiLab/borealis-12b-instruct-preview-gguf:Q4_K_M" -c 4096
+```
+
+
+### Q8_0
+
+**Ollama:**
+```bash
+ollama run "hf.co/NbAiLab/borealis-12b-instruct-preview-gguf:Q8_0"
+```
+
+**LM Studio:**
+```bash
+lms load "NbAiLab/borealis-12b-instruct-preview-gguf/borealis-12b-instruct-preview-Q8_0.gguf"
+```
+
+**llama.cpp CLI:**
+```bash
+llama-cli --hf "NbAiLab/borealis-12b-instruct-preview-gguf:Q8_0" -p "The meaning to life and the universe is"
+```
+
+**llama.cpp Server:**
+```bash
+llama-server --hf "NbAiLab/borealis-12b-instruct-preview-gguf:Q8_0" -c 4096
+```
+
+
+### BF16
+
+**Ollama:**
+```bash
+ollama run "hf.co/NbAiLab/borealis-12b-instruct-preview-gguf:BF16"
+```
+
+**LM Studio:**
+```bash
+lms load "NbAiLab/borealis-12b-instruct-preview-gguf/borealis-12b-instruct-preview-BF16.gguf"
+```
+
+**llama.cpp CLI:**
+```bash
+llama-cli --hf "NbAiLab/borealis-12b-instruct-preview-gguf:BF16" -p "The meaning to life and the universe is"
+```
+
+**llama.cpp Server:**
+```bash
+llama-server --hf "NbAiLab/borealis-12b-instruct-preview-gguf:BF16" -c 4096
+```