NikolayKozloff commited on
Commit
d3b3bf7
1 Parent(s): d300a7b

Upload README.md with huggingface_hub

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