Update README.md

README.md

@@ -1,13 +1,4 @@
 ---
-extra_gated_heading: >-
-  Acknowledge to follow corresponding license to access the
-  repository
-extra_gated_button_content: Agree and access repository
-extra_gated_fields:
-  First Name: text
-  Last Name: text
-  Country: country
-  Affiliation: text
 license: cc-by-nc-4.0
 datasets:
 - Salesforce/xlam-function-calling-60k
@@ -21,52 +12,45 @@ tags:
 - mistral
 - pytorch
 quantized_by: bartowski
+base_model: Salesforce/xLAM-7b-r
+lm_studio:
+  param_count: 7b
+  use_case: actions
+  release_date: 29-08-2024
+  model_creator: Salesforce
+  prompt_template: Mistral Instruct
+  base_model: Mistral
+  original_repo: Salesforce/xLAM-7b-r
 ---
+## 💫 Community Model> xLAM 7b r by Salesforce
 
-## Llamacpp Static (no imatrix) Quantizations of xLAM-7b-r
+*👾 [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/b3634">b3634</a> for quantization.
+**Model creator:** [Salesforce](https://huggingface.co/Salesforce)<br>
+**Original model**: [xLAM-7b-r](https://huggingface.co/Salesforce/xLAM-7b-r)<br>
+**GGUF quantization:** provided by [bartowski](https://huggingface.co/bartowski) based on `llama.cpp` release [b3634](https://github.com/ggerganov/llama.cpp/releases/tag/b3634)<br>
 
-Original model: https://huggingface.co/Salesforce/xLAM-7b-r
+## Model Summary:
+xLAM-7b-r is a tool use model by Salesforce. It is intended for use with advanced tools, not general chat.
 
-## Prompt format
+## Prompt Template:
 
-No prompt format
+Choose the `Mistral Instruct` preset in your LM Studio.
+Under the hood, the model will see a prompt that's formatted like so:
 
-## Download a file (not the whole branch) from below:
+```
+[INST] {prompt}[/INST]
+```
 
-| Filename | Quant type | File Size | Description |
-| -------- | ---------- | --------- | ----------- |
-| [xLAM-7b-r-Q8_0.gguf](https://huggingface.co/bartowski/xLAM-7b-r-GGUF/blob/main/xLAM-7b-r-Q8_0.gguf) | Q8_0 | 7.69GB | Extremely high quality, generally unneeded but max available quant. |
-| [xLAM-7b-r-Q6_K.gguf](https://huggingface.co/bartowski/xLAM-7b-r-GGUF/blob/main/xLAM-7b-r-Q6_K.gguf) | Q6_K | 5.94GB | Very high quality, near perfect, *recommended*. |
-| [xLAM-7b-r-Q5_K_M.gguf](https://huggingface.co/bartowski/xLAM-7b-r-GGUF//main/xLAM-7b-r-Q5_K_M.gguf) | Q5_K_M |  | High quality, *recommended*. |
-| [xLAM-7b-r-Q4_K_M.gguf](https://huggingface.co/bartowski/xLAM-7b-r-GGUF/blob/main/xLAM-7b-r-Q4_K_M.gguf) | Q4_K_M | 4.36GB | Good quality, uses about 4.83 bits per weight, *recommended*. |
-| [xLAM-7b-r-IQ4_NL.gguf](https://huggingface.co/bartowski/xLAM-7b-r-GGUF//main/xLAM-7b-r-IQ4_NL.gguf) | IQ4_NL |  | Decent quality, slightly smaller than Q4_K_S with similar performance *recommended*. |
-| [xLAM-7b-r-Q3_K_L.gguf](https://huggingface.co/bartowski/xLAM-7b-r-GGUF//main/xLAM-7b-r-Q3_K_L.gguf) | Q3_K_L |  | Lower quality but usable, good for low RAM availability. |
-| [xLAM-7b-r-Q2_K.gguf](https://huggingface.co/bartowski/xLAM-7b-r-GGUF//main/xLAM-7b-r-Q2_K.gguf) | Q2_K |  | Very low quality but surprisingly usable. |
+For information on formatting the tools, please refer to the instructions on the [original repository](https://huggingface.co/Salesforce/xLAM-7b-r#1-single-turn-use-case)
 
-## Which file should I choose?
+## Technical Details
+This model series is tuned explicitly for use with tools and should only be considered for such tasks.
 
-A great write up with charts showing various performances is provided by Artefact2 [here](https://gist.github.com/Artefact2/b5f810600771265fc1e39442288e8ec9)
+## Special thanks
 
-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.
+🙏 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.
 
-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.
+## Disclaimers
 
-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.
-
-If you want to get more into the weeds, you can check out this extremely useful feature chart:
-
-[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.
-
-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.
-
-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.
-
-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.