Upload README.md with huggingface_hub

README.md

@@ -1,67 +1,56 @@
 ---
-base_model: universitytehran/PersianMind-v1.0
 language:
 - multilingual
 - fa
 - en
-library_name: transformers
 license: cc-by-nc-sa-4.0
+library_name: transformers
+tags:
+- text-generation-inference
+- llama-cpp
+- gguf-my-repo
 metrics:
 - bleu
 - comet
 - accuracy
 - perplexity
 - spearmanr
-pipeline_tag: text-generation
-tags:
-- text-generation-inference
-- llama-cpp
-- gguf-my-repo
 inference: false
+pipeline_tag: text-generation
 co2_eq_emissions:
   emissions: 232380
+  source: 'PersianMind: A Cross-Lingual Persian-English Large Language Model. https://arxiv.org/abs/2401.06466'
+  training_type: fine-tuning
+  hardware_used: 4 RTX3090 24GB GPUs
+  geographical_location: Tehran, Iran
 ---
 
 # ysn-rfd/PersianMind-v1.0-Q4_K_M-GGUF
 This model was converted to GGUF format from [`universitytehran/PersianMind-v1.0`](https://huggingface.co/universitytehran/PersianMind-v1.0) 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/universitytehran/PersianMind-v1.0) 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
+Install llama.cpp through brew.
 
+```bash
+brew install ggerganov/ggerganov/llama.cpp
 ```
 Invoke the llama.cpp server or the CLI.
 
-### CLI:
-```bash
-llama-cli --hf-repo ysn-rfd/PersianMind-v1.0-Q4_K_M-GGUF --hf-file persianmind-v1.0-q4_k_m.gguf -p "The meaning to life and the universe is"
-```
+CLI:
 
-### Server:
 ```bash
-llama-server --hf-repo ysn-rfd/PersianMind-v1.0-Q4_K_M-GGUF --hf-file persianmind-v1.0-q4_k_m.gguf -c 2048
+llama-cli --hf-repo ysn-rfd/PersianMind-v1.0-Q4_K_M-GGUF --model persianmind-v1.0.Q4_K_M.gguf -p "The meaning to life and the universe is"
 ```
 
-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.
+Server:
 
-Step 1: Clone llama.cpp from GitHub.
-```
-git clone https://github.com/ggerganov/llama.cpp
+```bash
+llama-server --hf-repo ysn-rfd/PersianMind-v1.0-Q4_K_M-GGUF --model persianmind-v1.0.Q4_K_M.gguf -c 2048
 ```
 
-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
-```
+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 3: Run inference through the main binary.
-```
-./llama-cli --hf-repo ysn-rfd/PersianMind-v1.0-Q4_K_M-GGUF --hf-file persianmind-v1.0-q4_k_m.gguf -p "The meaning to life and the universe is"
-```
-or 
 ```
-./llama-server --hf-repo ysn-rfd/PersianMind-v1.0-Q4_K_M-GGUF --hf-file persianmind-v1.0-q4_k_m.gguf -c 2048
+git clone https://github.com/ggerganov/llama.cpp &&             cd llama.cpp &&             make &&             ./main -m persianmind-v1.0.Q4_K_M.gguf -n 128
 ```