bartowski commited on
Commit
8764094
1 Parent(s): 8a6c76e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +31 -84
README.md CHANGED
@@ -13,108 +13,55 @@ tags:
13
  - multi-image
14
  - video
15
  - custom_code
16
- quantized_by: bartowski
 
 
 
 
 
 
 
 
17
  ---
 
18
 
19
- # This is my first vision model, it *may be broken*, I will attempt to test but making public so others can too
20
 
21
- ## Llamacpp Static Quantizations of MiniCPM-V-2_6
 
 
22
 
23
- Using <a href="https://github.com/ggerganov/llama.cpp/">llama.cpp</a> release <a href="https://github.com/ggerganov/llama.cpp/releases/tag/b3600">b3600</a> for quantization.
24
 
25
- Original model: https://huggingface.co/openbmb/MiniCPM-V-2_6
 
 
26
 
27
- ## Prompt format
 
 
 
28
 
29
  ```
30
  <|im_start|>system
31
- {system_prompt}<|im_end|>
32
  <|im_start|>user
33
  {prompt}<|im_end|>
34
  <|im_start|>assistant
35
- ```
36
-
37
- ## Download a file (not the whole branch) from below:
38
-
39
- | Filename | Quant type | File Size | Split | Description |
40
- | -------- | ---------- | --------- | ----- | ----------- |
41
- | [MiniCPM-V-2_6-f16.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-f16.gguf) | f16 | 15.23GB | false | Full F16 weights. |
42
- | [MiniCPM-V-2_6-Q8_0.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-Q8_0.gguf) | Q8_0 | 8.10GB | false | Extremely high quality, generally unneeded but max available quant. |
43
- | [MiniCPM-V-2_6-Q6_K_L.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-Q6_K_L.gguf) | Q6_K_L | 6.52GB | false | Uses Q8_0 for embed and output weights. Very high quality, near perfect, *recommended*. |
44
- | [MiniCPM-V-2_6-Q6_K.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-Q6_K.gguf) | Q6_K | 6.25GB | false | Very high quality, near perfect, *recommended*. |
45
- | [MiniCPM-V-2_6-Q5_K_L.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-Q5_K_L.gguf) | Q5_K_L | 5.78GB | false | Uses Q8_0 for embed and output weights. High quality, *recommended*. |
46
- | [MiniCPM-V-2_6-Q5_K_M.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-Q5_K_M.gguf) | Q5_K_M | 5.44GB | false | High quality, *recommended*. |
47
- | [MiniCPM-V-2_6-Q5_K_S.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-Q5_K_S.gguf) | Q5_K_S | 5.31GB | false | High quality, *recommended*. |
48
- | [MiniCPM-V-2_6-Q4_K_L.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-Q4_K_L.gguf) | Q4_K_L | 5.08GB | false | Uses Q8_0 for embed and output weights. Good quality, *recommended*. |
49
- | [MiniCPM-V-2_6-Q4_K_M.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-Q4_K_M.gguf) | Q4_K_M | 4.68GB | false | Good quality, default size for must use cases, *recommended*. |
50
- | [MiniCPM-V-2_6-Q3_K_XL.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-Q3_K_XL.gguf) | Q3_K_XL | 4.56GB | false | Uses Q8_0 for embed and output weights. Lower quality but usable, good for low RAM availability. |
51
- | [MiniCPM-V-2_6-Q4_K_S.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-Q4_K_S.gguf) | Q4_K_S | 4.46GB | false | Slightly lower quality with more space savings, *recommended*. |
52
- | [MiniCPM-V-2_6-IQ4_XS.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-IQ4_XS.gguf) | IQ4_XS | 4.25GB | false | Decent quality, smaller than Q4_K_S with similar performance, *recommended*. |
53
- | [MiniCPM-V-2_6-Q3_K_L.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-Q3_K_L.gguf) | Q3_K_L | 4.09GB | false | Lower quality but usable, good for low RAM availability. |
54
- | [MiniCPM-V-2_6-Q3_K_M.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-Q3_K_M.gguf) | Q3_K_M | 3.81GB | false | Low quality. |
55
- | [MiniCPM-V-2_6-IQ3_M.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-IQ3_M.gguf) | IQ3_M | 3.57GB | false | Medium-low quality, new method with decent performance comparable to Q3_K_M. |
56
- | [MiniCPM-V-2_6-Q2_K_L.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-Q2_K_L.gguf) | Q2_K_L | 3.55GB | false | Uses Q8_0 for embed and output weights. Very low quality but surprisingly usable. |
57
- | [MiniCPM-V-2_6-Q2_K.gguf](https://huggingface.co/bartowski/MiniCPM-V-2_6-GGUF/blob/main/MiniCPM-V-2_6-Q2_K.gguf) | Q2_K | 3.01GB | false | Very low quality but surprisingly usable. |
58
-
59
- ## Embed/output weights
60
-
61
- Some of these quants (Q3_K_XL, Q4_K_L etc) are the standard quantization method with the embeddings and output weights quantized to Q8_0 instead of what they would normally default to.
62
-
63
- Some say that this improves the quality, others don't notice any difference. If you use these models PLEASE COMMENT with your findings. I would like feedback that these are actually used and useful so I don't keep uploading quants no one is using.
64
-
65
- Thanks!
66
-
67
- ## Credits
68
-
69
- Thank you kalomaze and Dampf for assistance in creating the imatrix calibration dataset
70
-
71
- Thank you ZeroWw for the inspiration to experiment with embed/output
72
-
73
- ## Downloading using huggingface-cli
74
-
75
- First, make sure you have hugginface-cli installed:
76
-
77
- ```
78
- pip install -U "huggingface_hub[cli]"
79
- ```
80
-
81
- Then, you can target the specific file you want:
82
-
83
- ```
84
- huggingface-cli download bartowski/MiniCPM-V-2_6-GGUF --include "MiniCPM-V-2_6-Q4_K_M.gguf" --local-dir ./
85
- ```
86
-
87
- If the model is bigger than 50GB, it will have been split into multiple files. In order to download them all to a local folder, run:
88
 
89
  ```
90
- huggingface-cli download bartowski/MiniCPM-V-2_6-GGUF --include "MiniCPM-V-2_6-Q8_0/*" --local-dir ./
91
- ```
92
-
93
- You can either specify a new local-dir (MiniCPM-V-2_6-Q8_0) or download them all in place (./)
94
-
95
- ## Which file should I choose?
96
-
97
- A great write up with charts showing various performances is provided by Artefact2 [here](https://gist.github.com/Artefact2/b5f810600771265fc1e39442288e8ec9)
98
-
99
- The first thing to figure out is how big a model you can run. To do this, you'll need to figure out how much RAM and/or VRAM you have.
100
-
101
- If you want your model running as FAST as possible, you'll want to fit the whole thing on your GPU's VRAM. Aim for a quant with a file size 1-2GB smaller than your GPU's total VRAM.
102
-
103
- If you want the absolute maximum quality, add both your system RAM and your GPU's VRAM together, then similarly grab a quant with a file size 1-2GB Smaller than that total.
104
-
105
- Next, you'll need to decide if you want to use an 'I-quant' or a 'K-quant'.
106
-
107
- If you don't want to think too much, grab one of the K-quants. These are in format 'QX_K_X', like Q5_K_M.
108
 
109
- If you want to get more into the weeds, you can check out this extremely useful feature chart:
 
110
 
111
- [llama.cpp feature matrix](https://github.com/ggerganov/llama.cpp/wiki/Feature-matrix)
112
 
113
- But basically, if you're aiming for below Q4, and you're running cuBLAS (Nvidia) or rocBLAS (AMD), you should look towards the I-quants. These are in format IQX_X, like IQ3_M. These are newer and offer better performance for their size.
114
 
115
- These I-quants can also be used on CPU and Apple Metal, but will be slower than their K-quant equivalent, so speed vs performance is a tradeoff you'll have to decide.
116
 
117
- The I-quants are *not* compatible with Vulcan, which is also AMD, so if you have an AMD card double check if you're using the rocBLAS build or the Vulcan build. At the time of writing this, LM Studio has a preview with ROCm support, and other inference engines have specific builds for ROCm.
118
 
119
- Want to support my work? Visit my ko-fi page here: https://ko-fi.com/bartowski
120
 
 
 
13
  - multi-image
14
  - video
15
  - custom_code
16
+ lm_studio:
17
+ param_count: 8b
18
+ use_case: image
19
+ release_date: 05-08-2024
20
+ model_creator: OpenBMB
21
+ prompt_template: ChatML
22
+ system_prompt: You are a helpful assistant.
23
+ base_model: MiniCPM-V
24
+ original_repo: openbmb/MiniCPM-V-2_6
25
  ---
26
+ ## 💫 Community Model> MiniCPM-V 2.6 by OpenBMB
27
 
28
+ *👾 [LM Studio](https://lmstudio.ai) Community models highlights program. Highlighting new & noteworthy models by the community. Join the conversation on [Discord](https://discord.gg/aPQfnNkxGC)*.
29
 
30
+ **Model creator:** [OpenBMB](https://huggingface.co/OpenBMB)<br>
31
+ **Original model**: [MiniCPM-V-2_6](https://huggingface.co/openbmb/MiniCPM-V-2_6)<br>
32
+ **GGUF quantization:** provided by [bartowski](https://huggingface.co/bartowski) based on `llama.cpp` release [b3600](https://github.com/ggerganov/llama.cpp/releases/tag/b3600)<br>
33
 
34
+ * Requires LM Studio version 0.3.0 and up, please check for updates
35
 
36
+ ## Model Summary:
37
+ MiniCPM-V 2.6 is the latest and most capable model in the MiniCPM-V series. The model is built on SigLip-400M and Qwen2-7B with a total of 8B parameters.<br>
38
+ It exhibits a significant performance improvement over MiniCPM-Llama3-V 2.5, and introduces new features for multi-image and video understanding.
39
 
40
+ ## Prompt Template:
41
+
42
+ Choose the `ChatML` preset in your LM Studio.
43
+ Under the hood, the model will see a prompt that's formatted like so:
44
 
45
  ```
46
  <|im_start|>system
47
+ You are a helpful assistant.<|im_end|>
48
  <|im_start|>user
49
  {prompt}<|im_end|>
50
  <|im_start|>assistant
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
51
 
52
  ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
53
 
54
+ ## Technical Details
55
+ MiniCPM-V 2.6 manages to beat widely used proprietary models like GPT-4o mini, GPT-4V, Gemini 1.5 Pro, and Claude 3.5 Sonnet for single image understanding.
56
 
57
+ MiniCPM-V 2.6 is capable of performing conversation and reasoning over multiple images, and is also able to accept video inputs
58
 
59
+ This model can process images with any aspect ratio and up to 1.8 million pixels (e.g., 1344x1344) and perform state of the art OCR on them.
60
 
61
+ ## Special thanks
62
 
63
+ 🙏 Special thanks to [Georgi Gerganov](https://github.com/ggerganov) and the whole team working on [llama.cpp](https://github.com/ggerganov/llama.cpp/) for making all of this possible.
64
 
65
+ ## Disclaimers
66
 
67
+ LM Studio is not the creator, originator, or owner of any Model featured in the Community Model Program. Each Community Model is created and provided by third parties. LM Studio does not endorse, support, represent or guarantee the completeness, truthfulness, accuracy, or reliability of any Community Model. You understand that Community Models can produce content that might be offensive, harmful, inaccurate or otherwise inappropriate, or deceptive. Each Community Model is the sole responsibility of the person or entity who originated such Model. LM Studio may not monitor or control the Community Models and cannot, and does not, take responsibility for any such Model. LM Studio disclaims all warranties or guarantees about the accuracy, reliability or benefits of the Community Models. LM Studio further disclaims any warranty that the Community Model will meet your requirements, be secure, uninterrupted or available at any time or location, or error-free, viruses-free, or that any errors will be corrected, or otherwise. You will be solely responsible for any damage resulting from your use of or access to the Community Models, your downloading of any Community Model, or use of any other Community Model provided by or through LM Studio.