Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,83 @@
+---
+language:
+- en
+- zh
+- id
+- th
+- vi
+- ms
+- lo
+- my
+- jv
+- km
+- su
+- tl
+tags:
+- multilingual
+- sea
+- sailor
+- sft
+- chat
+- instruction
+- llama-cpp
+- gguf-my-repo
+widget:
+- text: 如何制作烤鱼？
+  example_title: Chinese
+- text: How to bake fish?
+  example_title: English
+- text: Bagaimana cara memanggang ikan?
+  example_title: Malay
+- text: วิธีย่างปลา?
+  example_title: Thai
+- text: Bagaimana membuat bakaran ikan?
+  example_title: Indonesian
+- text: Làm thế nào để nướng cá?
+  example_title: Vietnamese
+license: apache-2.0
+base_model: sail/Sailor2-1B-Chat
+---
+
+# AIronMind/Sailor2-1B-Chat-Q4_K_M-GGUF
+This model was converted to GGUF format from [`sail/Sailor2-1B-Chat`](https://huggingface.co/sail/Sailor2-1B-Chat) 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/sail/Sailor2-1B-Chat) for more details on the model.
+
+## Use with llama.cpp
+Install llama.cpp through brew (works on Mac and Linux)
+
+```bash
+brew install llama.cpp
+
+```
+Invoke the llama.cpp server or the CLI.
+
+### CLI:
+```bash
+llama-cli --hf-repo AIronMind/Sailor2-1B-Chat-Q4_K_M-GGUF --hf-file sailor2-1b-chat-q4_k_m.gguf -p "The meaning to life and the universe is"
+```
+
+### Server:
+```bash
+llama-server --hf-repo AIronMind/Sailor2-1B-Chat-Q4_K_M-GGUF --hf-file sailor2-1b-chat-q4_k_m.gguf -c 2048
+```
+
+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.
+
+Step 1: Clone llama.cpp from GitHub.
+```
+git clone https://github.com/ggerganov/llama.cpp
+```
+
+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
+```
+
+Step 3: Run inference through the main binary.
+```
+./llama-cli --hf-repo AIronMind/Sailor2-1B-Chat-Q4_K_M-GGUF --hf-file sailor2-1b-chat-q4_k_m.gguf -p "The meaning to life and the universe is"
+```
+or 
+```
+./llama-server --hf-repo AIronMind/Sailor2-1B-Chat-Q4_K_M-GGUF --hf-file sailor2-1b-chat-q4_k_m.gguf -c 2048
+```