Triangle104 commited on
Commit
7eebfcf
1 Parent(s): 859a554

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +62 -0
README.md ADDED
@@ -0,0 +1,62 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language:
3
+ - en
4
+ - fr
5
+ - es
6
+ - pt
7
+ tags:
8
+ - falcon3
9
+ - abliterated
10
+ - uncensored
11
+ - llama-cpp
12
+ - gguf-my-repo
13
+ base_model: huihui-ai/Falcon3-1B-Instruct-abliterated
14
+ license: other
15
+ license_name: falcon-llm-license
16
+ license_link: https://falconllm.tii.ae/falcon-terms-and-conditions.html
17
+ library_name: transformers
18
+ ---
19
+
20
+ # Triangle104/Falcon3-1B-Instruct-abliterated-Q6_K-GGUF
21
+ This model was converted to GGUF format from [`huihui-ai/Falcon3-1B-Instruct-abliterated`](https://huggingface.co/huihui-ai/Falcon3-1B-Instruct-abliterated) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
22
+ Refer to the [original model card](https://huggingface.co/huihui-ai/Falcon3-1B-Instruct-abliterated) for more details on the model.
23
+
24
+ ## Use with llama.cpp
25
+ Install llama.cpp through brew (works on Mac and Linux)
26
+
27
+ ```bash
28
+ brew install llama.cpp
29
+
30
+ ```
31
+ Invoke the llama.cpp server or the CLI.
32
+
33
+ ### CLI:
34
+ ```bash
35
+ llama-cli --hf-repo Triangle104/Falcon3-1B-Instruct-abliterated-Q6_K-GGUF --hf-file falcon3-1b-instruct-abliterated-q6_k.gguf -p "The meaning to life and the universe is"
36
+ ```
37
+
38
+ ### Server:
39
+ ```bash
40
+ llama-server --hf-repo Triangle104/Falcon3-1B-Instruct-abliterated-Q6_K-GGUF --hf-file falcon3-1b-instruct-abliterated-q6_k.gguf -c 2048
41
+ ```
42
+
43
+ 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.
44
+
45
+ Step 1: Clone llama.cpp from GitHub.
46
+ ```
47
+ git clone https://github.com/ggerganov/llama.cpp
48
+ ```
49
+
50
+ 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).
51
+ ```
52
+ cd llama.cpp && LLAMA_CURL=1 make
53
+ ```
54
+
55
+ Step 3: Run inference through the main binary.
56
+ ```
57
+ ./llama-cli --hf-repo Triangle104/Falcon3-1B-Instruct-abliterated-Q6_K-GGUF --hf-file falcon3-1b-instruct-abliterated-q6_k.gguf -p "The meaning to life and the universe is"
58
+ ```
59
+ or
60
+ ```
61
+ ./llama-server --hf-repo Triangle104/Falcon3-1B-Instruct-abliterated-Q6_K-GGUF --hf-file falcon3-1b-instruct-abliterated-q6_k.gguf -c 2048
62
+ ```