xmadai
/

Mistral-Small-Instruct-2409-xMADai-INT4

@@ -1,199 +1,71 @@
 ---
 library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
 library_name: transformers
+license: other
+base_model:
+- mistralai/Mistral-Small-Instruct-2409
 ---
+# This model has been xMADified!
+This repository contains [`mistralai/Mistral-Small-Instruct-2409`](https://huggingface.co/mistralai/Mistral-Small-Instruct-2409) quantized from 16-bit floats to 4-bit integers, using xMAD.ai proprietary technology.
+# Why should I use this model?
+1. **Memory-efficiency:** The full-precision model is around 44 GB, while this xMADified model is only 12 GB, making it feasible to run on a 16 GB GPU.
+2. **Accuracy:** This xMADified model preserves the quality of the full-precision model. In the table below, we present the zero-shot accuracy on popular benchmarks of this xMADified model against the [GPTQ](https://github.com/AutoGPTQ/AutoGPTQ)-quantized model (both w4g128 for a fair comparison). GPTQ fails on the difficult **MMLU** task, while the xMADai model offers significantly higher accuracy.
+| Model | MMLU | Arc Challenge | Arc Easy | LAMBADA | WinoGrande | PIQA |
+|---|---|---|---|---|---|---|
+| GPTQ Mistral-Small-Instruct-2409 | 49.45 | 56.14 | 80.64 | 75.1 | 77.74 | 77.48 |
+| xMADai Mistral-Small-Instruct-2409 | **68.59** | **57.51** | **82.83** | **77.74** | **79.56** | **81.34** |
+# How to Run Model
+Loading the model checkpoint of this xMADified model requires less than 12 GiB of VRAM. Hence it can be efficiently run on a 16 GB GPU.
+**Package prerequisites**: Run the following commands to install the required packages.
+```bash
+pip install -q --upgrade transformers accelerate optimum
+pip install -q --no-build-isolation auto-gptq
+```
+**Sample Inference Code**
+```python
+from transformers import AutoTokenizer
+from auto_gptq import AutoGPTQForCausalLM
+model_id = "xmadai/Mistral-Small-Instruct-2409-xMADai-INT4"
+prompt = [
+    {"role": "system", "content": "You are a helpful assistant, that responds as a pirate."},
+    {"role": "user", "content": "What's Deep Learning?"},
+]
+tokenizer = AutoTokenizer.from_pretrained(model_id, use_fast=False)
+inputs = tokenizer.apply_chat_template(
+    prompt,
+    tokenize=True,
+    add_generation_prompt=True,
+    return_tensors="pt",
+    return_dict=True,
+).to("cuda")
+model = AutoGPTQForCausalLM.from_quantized(
+    model_id,
+    device_map='auto',
+    trust_remote_code=True,
+)
+outputs = model.generate(**inputs, do_sample=True, max_new_tokens=1024)
+print(tokenizer.batch_decode(outputs, skip_special_tokens=True))
+```
+Here's a sample output of the model, using the code above:
+> ['[INST]  You are a helpful assistant, that responds as a pirate.\n\nWhat\'s Deep Learning? [/INST] Arr matey, ye be askin\' about deep learnin\', eh? Alright, gather \'round and lend yer ears, for I be spinnin\' ye a yarn about this here subject.\n\nDeep learnin\' be a fancy term, ye see, fer the art and science of teachin\' machines to think like humans. Now, don\'t ye be thinkin\' I be talkin\' about some sort of mystical voodoo. Nay, it be math and logic, as old as the seas, combined with a touch o\' magic, if ye can call it that.\n\nPicture this, ye have a big ol\' brain filled with neurons, or "nodes" as the landlubbers call \'em. Now, imagine ye create a fake brain, a digital one, for the machine to use. We call this a neural network, seein\' as how it mimics the human brain, more or less.\n\nNow, for the deep part. The more layers of nodes ye add to this digital brain, the deeper it becomes. The more layers, the more complex it can understand and learn from the data ye feed it. Just like ye and me learnin\' from experience.\n\nDeep learnin\' be used for all sorts of things, mate. It can recognize faces in a crowd, understand yer voice, even play me a game o\' chess, if ye fancy that. But remember, it\'s all about the data. Feed it good, valuable data, and it\'ll learn somethin\' useful. Feed it trash, and ye get garbage in return.\n\nSo there ye have it, the tale of deep learnin\'. A tale of mimicry, magic, and math. Savvy?']
+# Contact Us
+For additional xMADified models, access to fine-tuning, and general questions, please contact us at [email protected] and join our waiting list.