Update README.md

README.md

@@ -1,3 +1,66 @@
 ---
-license: apache-2.0
+license: cc-by-nc-4.0
+tags:
+- merge
+- mergekit
+- lazymergekit
+base_model:
+- liminerity/M7-7b
+- rwitz/experiment26-truthy-iter-0
+quantized_by: suparious
+pipeline_tag: text-generation
 ---
+
+## Exllama v2 Quantizations of Zebrafish-7B
+
+Using <a href="https://github.com/turboderp/exllamav2/releases/tag/v0.0.17">turboderp's ExLlamaV2 v0.0.17</a> for quantization.
+
+<b>The "main" branch only contains the measurement.json, download one of the other branches for the model (see below)</b>
+
+Each branch contains an individual bits per weight, with the main one containing only the meaurement.json for further conversions.
+
+Original model: https://huggingface.co/mlabonne/Zebrafish-7B
+
+| Branch | Bits | lm_head bits | VRAM (4k) | VRAM (16k) | VRAM (32k) | Description |
+| ----- | ---- | ------- | ------ | ------ | ------ | ------------ |
+| [6_5](https://huggingface.co/suparious/Zebrafish-7B-exl2/tree/6_5) | 6.5 | 8.0 | 7.2 GB | 8.6 GB | 10.6 GB | Very similar to 8.0, good tradeoff of size vs performance, **recommended**. |
+| [5_0](https://huggingface.co/suparious/Zebrafish-7B-exl2/tree/5_0) | 5.0 | 6.0 | 6.0 GB | 7.4 GB |  9.4 GB | Slightly lower quality vs 6.5, but usable on 8GB cards. |
+| [4_25](https://huggingface.co/suparious/Zebrafish-7B-exl2/tree/4_25) | 4.25 | 6.0 | 5.3 GB | 6.7 GB | 8.7 GB | GPTQ equivalent bits per weight, slightly higher quality. |
+| [3_5](https://huggingface.co/suparious/Zebrafish-7B-exl2/tree/3_5) | 3.5 | 6.0 | 4.7 GB | 6.1 GB | 8.1 GB | Lower quality, only use if you have to. |
+
+## Download instructions
+
+With git:
+
+```shell
+git clone --single-branch --branch 6_5 https://huggingface.co/suparious/Zebrafish-7B-exl2 Zebrafish-7B-exl2-6_5
+```
+
+With huggingface hub (credit to TheBloke for instructions):
+
+```shell
+pip3 install huggingface-hub
+```
+
+To download the `main` (only useful if you only care about measurement.json) branch to a folder called `Zebrafish-7B-exl2`:
+
+```shell
+mkdir Zebrafish-7B-exl2
+huggingface-cli download suparious/Zebrafish-7B-exl2 --local-dir Zebrafish-7B-exl2 --local-dir-use-symlinks False
+```
+
+To download from a different branch, add the `--revision` parameter:
+
+Linux:
+
+```shell
+mkdir Zebrafish-7B-exl2-6_5
+huggingface-cli download suparious/Zebrafish-7B-exl2 --revision 6_5 --local-dir Zebrafish-7B-exl2-6_5 --local-dir-use-symlinks False
+```
+
+Windows (which apparently doesn't like _ in folders sometimes?):
+
+```shell
+mkdir Zebrafish-7B-exl2-6.5
+huggingface-cli download suparious/Zebrafish-7B-exl2 --revision 6_5 --local-dir Zebrafish-7B-exl2-6.5 --local-dir-use-symlinks False
+```