blogcncom commited on
Commit
defa936
1 Parent(s): 1b95537

Upload README.md with huggingface_hub

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