Triangle104 commited on
Commit
8d6e03e
1 Parent(s): da2a7fc

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +70 -0
README.md ADDED
@@ -0,0 +1,70 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: tiiuae/falcon-7b-instruct
3
+ datasets:
4
+ - tiiuae/falcon-refinedweb
5
+ language:
6
+ - en
7
+ license: apache-2.0
8
+ tags:
9
+ - llama-cpp
10
+ - gguf-my-repo
11
+ inference: true
12
+ widget:
13
+ - text: Hey Falcon! Any recommendations for my holidays in Abu Dhabi?
14
+ example_title: Abu Dhabi Trip
15
+ - text: What's the Everett interpretation of quantum mechanics?
16
+ example_title: 'Q/A: Quantum & Answers'
17
+ - text: Give me a list of the top 10 dive sites you would recommend around the world.
18
+ example_title: Diving Top 10
19
+ - text: Can you tell me more about deep-water soloing?
20
+ example_title: Extreme sports
21
+ - text: Can you write a short tweet about the Apache 2.0 release of our latest AI
22
+ model, Falcon LLM?
23
+ example_title: Twitter Helper
24
+ - text: What are the responsabilities of a Chief Llama Officer?
25
+ example_title: Trendy Jobs
26
+ ---
27
+
28
+ # Triangle104/falcon-7b-instruct-Q4_0-GGUF
29
+ This model was converted to GGUF format from [`tiiuae/falcon-7b-instruct`](https://huggingface.co/tiiuae/falcon-7b-instruct) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
30
+ Refer to the [original model card](https://huggingface.co/tiiuae/falcon-7b-instruct) for more details on the model.
31
+
32
+ ## Use with llama.cpp
33
+ Install llama.cpp through brew (works on Mac and Linux)
34
+
35
+ ```bash
36
+ brew install llama.cpp
37
+
38
+ ```
39
+ Invoke the llama.cpp server or the CLI.
40
+
41
+ ### CLI:
42
+ ```bash
43
+ llama-cli --hf-repo Triangle104/falcon-7b-instruct-Q4_0-GGUF --hf-file falcon-7b-instruct-q4_0.gguf -p "The meaning to life and the universe is"
44
+ ```
45
+
46
+ ### Server:
47
+ ```bash
48
+ llama-server --hf-repo Triangle104/falcon-7b-instruct-Q4_0-GGUF --hf-file falcon-7b-instruct-q4_0.gguf -c 2048
49
+ ```
50
+
51
+ 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.
52
+
53
+ Step 1: Clone llama.cpp from GitHub.
54
+ ```
55
+ git clone https://github.com/ggerganov/llama.cpp
56
+ ```
57
+
58
+ 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).
59
+ ```
60
+ cd llama.cpp && LLAMA_CURL=1 make
61
+ ```
62
+
63
+ Step 3: Run inference through the main binary.
64
+ ```
65
+ ./llama-cli --hf-repo Triangle104/falcon-7b-instruct-Q4_0-GGUF --hf-file falcon-7b-instruct-q4_0.gguf -p "The meaning to life and the universe is"
66
+ ```
67
+ or
68
+ ```
69
+ ./llama-server --hf-repo Triangle104/falcon-7b-instruct-Q4_0-GGUF --hf-file falcon-7b-instruct-q4_0.gguf -c 2048
70
+ ```