Update README.md

README.md

@@ -1,6 +1,5 @@
 ---
 license: llama3
-base_model: meta-llama/Meta-Llama-3-8B
 tags:
 - openchat
 - llama3
@@ -8,101 +7,60 @@ tags:
 library_name: transformers
 pipeline_tag: text-generation
 quantized_by: bartowski
+lm_studio:
+  param_count: 8b
+  use_case: chat
+  release_date: 22-05-2024
+  model_creator: OpenChat
+  prompt_template: OpenChat 3
+  system_prompt: You are a helpful AI assistant
+  base_model: llama
+  original_repo: openchat/openchat-3.6-8b-20240522
+base_model: openchat/openchat-3.6-8b-20240522
 ---
+## 💫 Community Model> OpenChat 3.6 8B 2024-05-22 by OpenChat
 
-## Llamacpp imatrix Quantizations of openchat-3.6-8b-20240522
+*👾 [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)*.
 
-Using <a href="https://github.com/ggerganov/llama.cpp/">llama.cpp</a> release <a href="https://github.com/ggerganov/llama.cpp/releases/tag/b2965">b2965</a> for quantization.
+**Model creator:** [OpenChat](https://huggingface.co/openchat)<br>
+**Original model**: [openchat-3.6-8b-20240522](https://huggingface.co/openchat/openchat-3.6-8b-20240522)<br>
+**GGUF quantization:** provided by [bartowski](https://huggingface.co/bartowski) based on `llama.cpp` release [b2965](https://github.com/ggerganov/llama.cpp/releases/tag/b2965)<br>
 
-Original model: https://huggingface.co/openchat/openchat-3.6-8b-20240522
+## Model Summary:
 
-All quants made using imatrix option with dataset from [here](https://gist.github.com/bartowski1182/b6ac44691e994344625687afe3263b3a)
+OpenChat is a series of models tuned for advanced chat functionality. It demonstrates steep improvements in many well known benchmarks.<br>
+This should be used as a general purpose chat model.
 
-## Prompt format
+## Prompt template:
 
-```
-<|begin_of_text|><|start_header_id|>System<|end_header_id|>
-
-{system_prompt}<|eot_id|><|start_header_id|>GPT4 Correct User<|end_header_id|>
-
-{prompt}<|eot_id|><|start_header_id|>GPT4 Correct Assistant<|end_header_id|>
-
-<|eot_id|><|start_header_id|>GPT4 Correct Assistant<|end_header_id|>
+Choose the `OpenChat 3` preset in your LM Studio.
 
+Under the hood, the model will see a prompt that's formatted like so:
 
 ```
+<|start_header_id|>GPT4 Correct User<|end_header_id|>
 
-## Download a file (not the whole branch) from below:
-
-| Filename | Quant type | File Size | Description |
-| -------- | ---------- | --------- | ----------- |
-| [openchat-3.6-8b-20240522-Q8_0.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-Q8_0.gguf) | Q8_0 | 8.54GB | Extremely high quality, generally unneeded but max available quant. |
-| [openchat-3.6-8b-20240522-Q6_K.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-Q6_K.gguf) | Q6_K | 6.59GB | Very high quality, near perfect, *recommended*. |
-| [openchat-3.6-8b-20240522-Q5_K_M.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-Q5_K_M.gguf) | Q5_K_M | 5.73GB | High quality, *recommended*. |
-| [openchat-3.6-8b-20240522-Q5_K_S.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-Q5_K_S.gguf) | Q5_K_S | 5.59GB | High quality, *recommended*. |
-| [openchat-3.6-8b-20240522-Q4_K_M.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-Q4_K_M.gguf) | Q4_K_M | 4.92GB | Good quality, uses about 4.83 bits per weight, *recommended*. |
-| [openchat-3.6-8b-20240522-Q4_K_S.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-Q4_K_S.gguf) | Q4_K_S | 4.69GB | Slightly lower quality with more space savings, *recommended*. |
-| [openchat-3.6-8b-20240522-IQ4_NL.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-IQ4_NL.gguf) | IQ4_NL | 4.67GB | Decent quality, slightly smaller than Q4_K_S with similar performance *recommended*. |
-| [openchat-3.6-8b-20240522-IQ4_XS.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-IQ4_XS.gguf) | IQ4_XS | 4.44GB | Decent quality, smaller than Q4_K_S with similar performance, *recommended*. |
-| [openchat-3.6-8b-20240522-Q3_K_L.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-Q3_K_L.gguf) | Q3_K_L | 4.32GB | Lower quality but usable, good for low RAM availability. |
-| [openchat-3.6-8b-20240522-Q3_K_M.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-Q3_K_M.gguf) | Q3_K_M | 4.01GB | Even lower quality. |
-| [openchat-3.6-8b-20240522-IQ3_M.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-IQ3_M.gguf) | IQ3_M | 3.78GB | Medium-low quality, new method with decent performance comparable to Q3_K_M. |
-| [openchat-3.6-8b-20240522-IQ3_S.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-IQ3_S.gguf) | IQ3_S | 3.68GB | Lower quality, new method with decent performance, recommended over Q3_K_S quant, same size with better performance. |
-| [openchat-3.6-8b-20240522-Q3_K_S.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-Q3_K_S.gguf) | Q3_K_S | 3.66GB | Low quality, not recommended. |
-| [openchat-3.6-8b-20240522-IQ3_XS.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-IQ3_XS.gguf) | IQ3_XS | 3.51GB | Lower quality, new method with decent performance, slightly better than Q3_K_S. |
-| [openchat-3.6-8b-20240522-IQ3_XXS.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-IQ3_XXS.gguf) | IQ3_XXS | 3.27GB | Lower quality, new method with decent performance, comparable to Q3 quants. |
-| [openchat-3.6-8b-20240522-Q2_K.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-Q2_K.gguf) | Q2_K | 3.17GB | Very low quality but surprisingly usable. |
-| [openchat-3.6-8b-20240522-IQ2_M.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-IQ2_M.gguf) | IQ2_M | 2.94GB | Very low quality, uses SOTA techniques to also be surprisingly usable. |
-| [openchat-3.6-8b-20240522-IQ2_S.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-IQ2_S.gguf) | IQ2_S | 2.75GB | Very low quality, uses SOTA techniques to be usable. |
-| [openchat-3.6-8b-20240522-IQ2_XS.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-IQ2_XS.gguf) | IQ2_XS | 2.60GB | Very low quality, uses SOTA techniques to be usable. |
-| [openchat-3.6-8b-20240522-IQ2_XXS.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-IQ2_XXS.gguf) | IQ2_XXS | 2.39GB | Lower quality, uses SOTA techniques to be usable. |
-| [openchat-3.6-8b-20240522-IQ1_M.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-IQ1_M.gguf) | IQ1_M | 2.16GB | Extremely low quality, *not* recommended. |
-| [openchat-3.6-8b-20240522-IQ1_S.gguf](https://huggingface.co/bartowski/openchat-3.6-8b-20240522-GGUF/blob/main/openchat-3.6-8b-20240522-IQ1_S.gguf) | IQ1_S | 2.01GB | Extremely low quality, *not* recommended. |
-
-## Downloading using huggingface-cli
-
-First, make sure you have hugginface-cli installed:
+{User}<|eot_id|><|start_header_id|>GPT4 Correct Assistant<|end_header_id|>
 
+{Assistant}
 ```
-pip install -U "huggingface_hub[cli]"
-```
-
-Then, you can target the specific file you want:
-
-```
-huggingface-cli download bartowski/openchat-3.6-8b-20240522-GGUF --include "openchat-3.6-8b-20240522-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/openchat-3.6-8b-20240522-GGUF --include "openchat-3.6-8b-20240522-Q8_0.gguf/*" --local-dir openchat-3.6-8b-20240522-Q8_0
-```
-
-You can either specify a new local-dir (openchat-3.6-8b-20240522-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.
+Note: Until OpenChat 3 is added, you can select OpenChat and add the proper <|start_header_id|>, <|eot_id|> and <|end_header_id|> tokens.
 
-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.
+## Technical Details
 
-Next, you'll need to decide if you want to use an 'I-quant' or a 'K-quant'.
+There is not much openly available information on the training of this model. Below is their reported benchmark scores.
 
-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.
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6435718aaaef013d1aec3b8b/jbCfjIjB5C9kjhC6er6zb.png)
 
-If you want to get more into the weeds, you can check out this extremely useful feature chart:
+* Llama-3-Instruct often fails to follow the few-shot templates.
 
-[llama.cpp feature matrix](https://github.com/ggerganov/llama.cpp/wiki/Feature-matrix)
+## Special thanks
 
-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 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.
 
-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 [Kalomaze](https://github.com/kalomaze), [Dampf](https://github.com/Dampfinchen) and [turboderp](https://github.com/turboderp/) for their work on the dataset (linked [here](https://gist.github.com/bartowski1182/b6ac44691e994344625687afe3263b3a)) that was used for calculating the imatrix for all sizes.
 
-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.
+## Disclaimers
 
-Want to support my work? Visit my ko-fi page here: https://ko-fi.com/bartowski
+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.