AlirezaF138 commited on
Commit
0ee9651
1 Parent(s): ee9bf65

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +59 -0
README.md ADDED
@@ -0,0 +1,59 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: cc-by-nc-4.0
3
+ language:
4
+ - fa
5
+ library_name: transformers
6
+ tags:
7
+ - text-generation-inference
8
+ - llama-cpp
9
+ - gguf-my-repo
10
+ inference: false
11
+ pipeline_tag: text-generation
12
+ datasets:
13
+ - sinarashidi/alpaca-persian
14
+ base_model: ViraIntelligentDataMining/PersianLLaMA-13B-Instruct
15
+ ---
16
+
17
+ # AlirezaF138/PersianLLaMA-13B-Instruct-Q8_0-GGUF
18
+ This model was converted to GGUF format from [`ViraIntelligentDataMining/PersianLLaMA-13B-Instruct`](https://huggingface.co/ViraIntelligentDataMining/PersianLLaMA-13B-Instruct) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
19
+ Refer to the [original model card](https://huggingface.co/ViraIntelligentDataMining/PersianLLaMA-13B-Instruct) for more details on the model.
20
+
21
+ ## Use with llama.cpp
22
+ Install llama.cpp through brew (works on Mac and Linux)
23
+
24
+ ```bash
25
+ brew install llama.cpp
26
+
27
+ ```
28
+ Invoke the llama.cpp server or the CLI.
29
+
30
+ ### CLI:
31
+ ```bash
32
+ llama-cli --hf-repo AlirezaF138/PersianLLaMA-13B-Instruct-Q8_0-GGUF --hf-file persianllama-13b-instruct-q8_0.gguf -p "The meaning to life and the universe is"
33
+ ```
34
+
35
+ ### Server:
36
+ ```bash
37
+ llama-server --hf-repo AlirezaF138/PersianLLaMA-13B-Instruct-Q8_0-GGUF --hf-file persianllama-13b-instruct-q8_0.gguf -c 2048
38
+ ```
39
+
40
+ 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.
41
+
42
+ Step 1: Clone llama.cpp from GitHub.
43
+ ```
44
+ git clone https://github.com/ggerganov/llama.cpp
45
+ ```
46
+
47
+ 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).
48
+ ```
49
+ cd llama.cpp && LLAMA_CURL=1 make
50
+ ```
51
+
52
+ Step 3: Run inference through the main binary.
53
+ ```
54
+ ./llama-cli --hf-repo AlirezaF138/PersianLLaMA-13B-Instruct-Q8_0-GGUF --hf-file persianllama-13b-instruct-q8_0.gguf -p "The meaning to life and the universe is"
55
+ ```
56
+ or
57
+ ```
58
+ ./llama-server --hf-repo AlirezaF138/PersianLLaMA-13B-Instruct-Q8_0-GGUF --hf-file persianllama-13b-instruct-q8_0.gguf -c 2048
59
+ ```