pmysl commited on
Commit
7d4fb9d
1 Parent(s): 349f168

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +19 -4
README.md CHANGED
@@ -1,14 +1,29 @@
1
  ---
2
  license: cc-by-nc-4.0
 
 
3
  ---
4
 
5
  # Command R+ GGUF
6
 
7
  ## Description
8
- This repository contains GGUF weights for the `llama.cpp`
9
 
10
- ## Concatenating Weights
11
- For every variant (except Q2_K), you must concatenate the weights, as they exceed the 50 GB single file size limit on HuggingFace. You can accomplish this using the `cat` command on Linux (example for the Q3 variant):
12
  ```bash
13
- cat command-r-plus-Q3_K_L-0000* > command-r-plus-Q3_K_L.gguf
 
 
 
 
 
 
 
 
 
 
 
 
 
14
  ```
 
1
  ---
2
  license: cc-by-nc-4.0
3
+ pipeline_tag: text-generation
4
+ base_model: CohereForAI/c4ai-command-r-plus
5
  ---
6
 
7
  # Command R+ GGUF
8
 
9
  ## Description
10
+ This repository contains experimental GGUF weights that are currently compatible with [pull request #6491](https://github.com/ggerganov/llama.cpp/pull/6491) in the `llama.cpp`. I will update them once support for Command R+ is merged into the llama.cpp repository.
11
 
12
+ ## Getting started
13
+ 1. Clone the `Carolinabanana/llama.cpp` repository:
14
  ```bash
15
+ git clone https://github.com/Carolinabanana/llama.cpp.git llama.cpp-fork
16
+ cd llama.cpp-fork
17
+ git reset --hard 8b6577bd631fec33eeadb4b9dfc5a07ed2118148
18
+ ```
19
+ 2. Build it using `make`
20
+ 3. Use it in the same way as the regular `llama.cpp`. If you're unsure of how to start, you can use the following command as a starting point:
21
+ ```bash
22
+ ./main -p "<|START_OF_TURN_TOKEN|><|USER_TOKEN|>Who are you?<|END_OF_TURN_TOKEN|><|START_OF_TURN_TOKEN|><|CHATBOT_TOKEN|>" --color -m /path/to/command-r-plus-Q3_K_L-00001-of-00002.gguf
23
+ ```
24
+
25
+ ## Merging Weights
26
+ After commit `8a28d12`, weights are split with `gguf-split`, which means that you don't have to merge weights. Simply pass the first split, as in the example above, and `llama.cpp` will automatically load all splits. If, for some reason, you want to merge splits, you can use the following command:
27
+ ```bash
28
+ ./gguf-split --merge /path/to/command-r-plus-f16-00001-of-00005.gguf /path/to/command-r-plus-f16-combined.gguf
29
  ```