Upload README.md with huggingface_hub

README.md

@@ -1,109 +1,43 @@
 ---
-base_model: internlm/internlm2_5-1_8b-chat
-license: other
-pipeline_tag: text-generation
 quantized_by: bartowski
+pipeline_tag: text-generation
 ---
+## 💫 Community Model> internlm2_5 1_8b chat by Internlm
 
-## Llamacpp imatrix Quantizations of internlm2_5-1_8b-chat
-
-Using <a href="https://github.com/ggerganov/llama.cpp/">llama.cpp</a> release <a href="https://github.com/ggerganov/llama.cpp/releases/tag/b3561">b3561</a> for quantization.
+*👾 [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)*.
 
-Original model: https://huggingface.co/internlm/internlm2_5-1_8b-chat
+**Model creator:** [internlm](https://huggingface.co/internlm)<br>
+**Original model**: [internlm2_5-1_8b-chat](https://huggingface.co/internlm/internlm2_5-1_8b-chat)<br>
+**GGUF quantization:** provided by [bartowski](https://huggingface.co/bartowski) based on `llama.cpp` release [b3561](https://github.com/ggerganov/llama.cpp/releases/tag/b3561)<br>
 
-All quants made using imatrix option with dataset from [here](https://gist.github.com/bartowski1182/eb213dccb3571f863da82e99418f81e8)
+## Model Summary:
+InternLM has continued their 2.5 series of models with a 1.8b chat model release. This model has advanced math and reasoning abilities, and surpasses other models in this size category.<br>Additionally, 2.5 features strong tool use and instruction following. It can be used with the InternLM tool [MindSearch](https://github.com/InternLM/MindSearch).<br>
 
-Run them in [LM Studio](https://lmstudio.ai/)
+## Prompt Template:
 
-## Prompt format
+Choose the `ChatML` preset in your LM Studio.
+Under the hood, the model will see a prompt that's formatted like so:
 
 ```
-<s><|im_start|>system
+<|im_start|>system
 {system_prompt}<|im_end|>
 <|im_start|>user
 {prompt}<|im_end|>
 <|im_start|>assistant
-
-```
-
-## Download a file (not the whole branch) from below:
-
-| Filename | Quant type | File Size | Split | Description |
-| -------- | ---------- | --------- | ----- | ----------- |
-| [internlm2_5-1_8b-chat-f32.gguf](https://huggingface.co/bartowski/internlm2_5-1_8b-chat-GGUF/blob/main/internlm2_5-1_8b-chat-f32.gguf) | f32 | 7.56GB | false | Full F32 weights. |
-| [internlm2_5-1_8b-chat-Q8_0.gguf](https://huggingface.co/bartowski/internlm2_5-1_8b-chat-GGUF/blob/main/internlm2_5-1_8b-chat-Q8_0.gguf) | Q8_0 | 2.01GB | false | Extremely high quality, generally unneeded but max available quant. |
-| [internlm2_5-1_8b-chat-Q6_K_L.gguf](https://huggingface.co/bartowski/internlm2_5-1_8b-chat-GGUF/blob/main/internlm2_5-1_8b-chat-Q6_K_L.gguf) | Q6_K_L | 1.64GB | false | Uses Q8_0 for embed and output weights. Very high quality, near perfect, *recommended*. |
-| [internlm2_5-1_8b-chat-Q6_K.gguf](https://huggingface.co/bartowski/internlm2_5-1_8b-chat-GGUF/blob/main/internlm2_5-1_8b-chat-Q6_K.gguf) | Q6_K | 1.55GB | false | Very high quality, near perfect, *recommended*. |
-| [internlm2_5-1_8b-chat-Q5_K_L.gguf](https://huggingface.co/bartowski/internlm2_5-1_8b-chat-GGUF/blob/main/internlm2_5-1_8b-chat-Q5_K_L.gguf) | Q5_K_L | 1.47GB | false | Uses Q8_0 for embed and output weights. High quality, *recommended*. |
-| [internlm2_5-1_8b-chat-Q5_K_M.gguf](https://huggingface.co/bartowski/internlm2_5-1_8b-chat-GGUF/blob/main/internlm2_5-1_8b-chat-Q5_K_M.gguf) | Q5_K_M | 1.36GB | false | High quality, *recommended*. |
-| [internlm2_5-1_8b-chat-Q5_K_S.gguf](https://huggingface.co/bartowski/internlm2_5-1_8b-chat-GGUF/blob/main/internlm2_5-1_8b-chat-Q5_K_S.gguf) | Q5_K_S | 1.33GB | false | High quality, *recommended*. |
-| [internlm2_5-1_8b-chat-Q4_K_L.gguf](https://huggingface.co/bartowski/internlm2_5-1_8b-chat-GGUF/blob/main/internlm2_5-1_8b-chat-Q4_K_L.gguf) | Q4_K_L | 1.31GB | false | Uses Q8_0 for embed and output weights. Good quality, *recommended*. |
-| [internlm2_5-1_8b-chat-Q3_K_XL.gguf](https://huggingface.co/bartowski/internlm2_5-1_8b-chat-GGUF/blob/main/internlm2_5-1_8b-chat-Q3_K_XL.gguf) | Q3_K_XL | 1.20GB | false | Uses Q8_0 for embed and output weights. Lower quality but usable, good for low RAM availability. |
-| [internlm2_5-1_8b-chat-Q4_K_M.gguf](https://huggingface.co/bartowski/internlm2_5-1_8b-chat-GGUF/blob/main/internlm2_5-1_8b-chat-Q4_K_M.gguf) | Q4_K_M | 1.17GB | false | Good quality, default size for must use cases, *recommended*. |
-| [internlm2_5-1_8b-chat-Q4_K_S.gguf](https://huggingface.co/bartowski/internlm2_5-1_8b-chat-GGUF/blob/main/internlm2_5-1_8b-chat-Q4_K_S.gguf) | Q4_K_S | 1.12GB | false | Slightly lower quality with more space savings, *recommended*. |
-| [internlm2_5-1_8b-chat-IQ4_XS.gguf](https://huggingface.co/bartowski/internlm2_5-1_8b-chat-GGUF/blob/main/internlm2_5-1_8b-chat-IQ4_XS.gguf) | IQ4_XS | 1.06GB | false | Decent quality, smaller than Q4_K_S with similar performance, *recommended*. |
-| [internlm2_5-1_8b-chat-Q3_K_L.gguf](https://huggingface.co/bartowski/internlm2_5-1_8b-chat-GGUF/blob/main/internlm2_5-1_8b-chat-Q3_K_L.gguf) | Q3_K_L | 1.03GB | false | Lower quality but usable, good for low RAM availability. |
-| [internlm2_5-1_8b-chat-IQ3_M.gguf](https://huggingface.co/bartowski/internlm2_5-1_8b-chat-GGUF/blob/main/internlm2_5-1_8b-chat-IQ3_M.gguf) | IQ3_M | 0.91GB | false | Medium-low quality, new method with decent performance comparable to Q3_K_M. |
-
-## Embed/output weights
-
-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.
-
-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.
-
-Thanks!
-
-## Credits
-
-Thank you kalomaze and Dampf for assistance in creating the imatrix calibration dataset
-
-Thank you ZeroWw for the inspiration to experiment with embed/output
-
-## Downloading using huggingface-cli
-
-First, make sure you have hugginface-cli installed:
-
 ```
-pip install -U "huggingface_hub[cli]"
-```
-
-Then, you can target the specific file you want:
-
-```
-huggingface-cli download bartowski/internlm2_5-1_8b-chat-GGUF --include "internlm2_5-1_8b-chat-Q4_K_M.gguf" --local-dir ./
-```
-
-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:
-
-```
-huggingface-cli download bartowski/internlm2_5-1_8b-chat-GGUF --include "internlm2_5-1_8b-chat-Q8_0/*" --local-dir ./
-```
-
-You can either specify a new local-dir (internlm2_5-1_8b-chat-Q8_0) or download them all in place (./)
-
-## Which file should I choose?
-
-A great write up with charts showing various performances is provided by Artefact2 [here](https://gist.github.com/Artefact2/b5f810600771265fc1e39442288e8ec9)
-
-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.
-
-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.
-
-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.
-
-Next, you'll need to decide if you want to use an 'I-quant' or a 'K-quant'.
 
-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.
+## Technical Details
+This 1.8B model is great for edge compute or mobile devices, and achieves great scores for its size.
 
-If you want to get more into the weeds, you can check out this extremely useful feature chart:
+You can view the results and more comparisons on OpenCompass [here](https://rank.opencompass.org.cn/)
 
-[llama.cpp feature matrix](https://github.com/ggerganov/llama.cpp/wiki/Feature-matrix)
 
-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.
+## Special thanks
 
-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.
+🙏 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.
 
-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.
+🙏 Special thanks to [Kalomaze](https://github.com/kalomaze) and [Dampf](https://github.com/Dampfinchen) for their work on the dataset (linked [here](https://gist.github.com/bartowski1182/eb213dccb3571f863da82e99418f81e8)) that was used for calculating the imatrix for all sizes.
 
-Want to support my work? Visit my ko-fi page here: https://ko-fi.com/bartowski
+## Disclaimers
 
+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.