Upload README.md with huggingface_hub

README.md

@@ -1,199 +1,401 @@
 ---
-library_name: transformers
-tags: []
+base_model: microsoft/Phi-4-mini-instruct
+tags:
+- transformers
+- torchao
+- phi3
+license: apache-2.0
+language:
+- en
 ---
 
-# Model Card for Model ID
+# AWQ-INT4 microsoft/Phi-4-mini-instruct model
+
+- **Developed by:** jerryzh168
+- **License:** apache-2.0
+- **Quantized from Model :** microsoft/Phi-4-mini-instruct
+- **Quantization Method :** AWQ-INT4
+
+
+# Inference with vLLM
+Install vllm nightly and torchao nightly to get some recent changes:
+```
+pip install vllm --pre --extra-index-url https://wheels.vllm.ai/nightly
+pip install torchao
+```
+
+## Serving
+Then we can serve with the following command:
+```Shell
+# Server
+export MODEL=jerryzh168/Phi-4-mini-instruct-AWQ-INT4
+VLLM_DISABLE_COMPILE_CACHE=1 vllm serve $MODEL --tokenizer $MODEL -O3
+```
+
+```Shell
+# Client
+curl http://localhost:8000/v1/chat/completions -H "Content-Type: application/json" -d '{
+  "model": "jerryzh168/Phi-4-mini-instruct-AWQ-INT4",
+  "messages": [
+    {"role": "user", "content": "Give me a short introduction to large language models."}
+  ],
+  "temperature": 0.6,
+  "top_p": 0.95,
+  "top_k": 20,
+  "max_tokens": 32768
+}'
+```
+
+Note: please use `VLLM_DISABLE_COMPILE_CACHE=1` to disable compile cache when running this code, e.g. `VLLM_DISABLE_COMPILE_CACHE=1 python example.py`, since there are some issues with the composability of compile in vLLM and torchao,
+this is expected be resolved in pytorch 2.8.
+
+# Inference with Transformers
+
+Install the required packages:
+```Shell
+pip install git+https://github.com/huggingface/transformers@main
+pip install torchao
+pip install torch
+pip install accelerate
+```
+
+Example:
+```Py
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+model_name = "jerryzh168/Phi-4-mini-instruct-AWQ-INT4"
+
+# load the tokenizer and the model
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+model = AutoModelForCausalLM.from_pretrained(
+    model_name,
+    torch_dtype="auto",
+    device_map="auto"
+)
+
+# prepare the model input
+prompt = "Give me a short introduction to large language model."
+messages = [
+    {"role": "user", "content": prompt}
+]
+text = tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True,
+    enable_thinking=True # Switches between thinking and non-thinking modes. Default is True.
+)
+model_inputs = tokenizer([text], return_tensors="pt").to(model.device)
+
+# conduct text completion
+generated_ids = model.generate(
+    **model_inputs,
+    max_new_tokens=32768
+)
+output_ids = generated_ids[0][len(model_inputs.input_ids[0]):].tolist()
+
+# parsing thinking content
+try:
+    # rindex finding 151668 (</think>)
+    index = len(output_ids) - output_ids[::-1].index(151668)
+except ValueError:
+    index = 0
+
+thinking_content = tokenizer.decode(output_ids[:index], skip_special_tokens=True).strip("
+")
+content = tokenizer.decode(output_ids[index:], skip_special_tokens=True).strip("
+")
+
+print("thinking content:", thinking_content)
+print("content:", content)
+```
+
+
+
+
+# Quantization Recipe
+
+Install the required packages:
+```Shell
+pip install git+https://github.com/huggingface/transformers@main
+pip install --pre torchao --index-url https://download.pytorch.org/whl/nightly/cu126
+pip install torch
+pip install accelerate
+```
+
+
+
+Use the following code to get the quantized model:
+```Py
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer, TorchAoConfig
+
+model_id = "microsoft/Phi-4-mini-instruct"
+model_to_quantize = "microsoft/Phi-4-mini-instruct"
+
+
+from torchao.quantization import Int4WeightOnlyConfig, quantize_
+from torchao.prototype.awq import (
+    AWQConfig,
+)
+from torchao._models._eval import TransformerEvalWrapper
+model = AutoModelForCausalLM.from_pretrained(
+    model_to_quantize,
+    device_map="auto",
+    torch_dtype=torch.bfloat16,
+)
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+
+base_config = Int4WeightOnlyConfig(group_size=128, version=2)
+quant_config = AWQConfig(base_config, step="prepare")
+quantize_(
+    model,
+    quant_config,
+)
+TransformerEvalWrapper(
+    model=model,
+    tokenizer=tokenizer,
+    max_seq_length=max_seq_length,
+).run_eval(
+    tasks=tasks,
+    limit=calibration_limit,
+)
+quant_config = AWQConfig(base_config, step="convert")
+quantize_(model, quant_config)
+
+quantized_model = model
+quant_config = AWQConfig(base_config, step="prepare_for_loading")
+quantized_model.config.quantization_config = TorchAoConfig(quant_config)
+
+
+# Push to hub
+USER_ID = "YOUR_USER_ID"
+MODEL_NAME = model_id.split("/")[-1]
+save_to = f"{USER_ID}/{MODEL_NAME}-AWQ-INT4"
+quantized_model.push_to_hub(save_to, safe_serialization=False)
+tokenizer.push_to_hub(save_to)
+
+# Manual Testing
+prompt = "Hey, are you conscious? Can you talk to me?"
+messages = [
+    {
+        "role": "system",
+        "content": "",
+    },
+    {"role": "user", "content": prompt},
+]
+templated_prompt = tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True,
+)
+print("Prompt:", prompt)
+print("Templated prompt:", templated_prompt)
+inputs = tokenizer(
+    templated_prompt,
+    return_tensors="pt",
+).to("cuda")
+generated_ids = quantized_model.generate(**inputs, max_new_tokens=128)
+output_text = tokenizer.batch_decode(
+    generated_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False
+)
+print("Response:", output_text[0][len(prompt):])
+```
+
+Note: to `push_to_hub` you need to run
+```Shell
+pip install -U "huggingface_hub[cli]"
+huggingface-cli login
+```
+and use a token with write access, from https://huggingface.co/settings/tokens
+
+# Model Quality
+We rely on [lm-evaluation-harness](https://github.com/EleutherAI/lm-evaluation-harness) to evaluate the quality of the quantized model. Here we only run on mmlu for sanity check.
+
+| Benchmark                        |                |                           |
+|----------------------------------|----------------|---------------------------|
+|                                  | microsoft/Phi-4-mini-instruct   | jerryzh168/Phi-4-mini-instruct-AWQ-INT4         |
+| mmlu                             | To be filled   | To be filled                      |
+
+
+<details>
+<summary> Reproduce Model Quality Results </summary>
+
+Need to install lm-eval from source:
+https://github.com/EleutherAI/lm-evaluation-harness#install
+
+## baseline
+```Shell
+lm_eval --model hf --model_args pretrained=microsoft/Phi-4-mini-instruct --tasks mmlu --device cuda:0 --batch_size 8
+```
+
+## AWQ-INT4
+```Shell
+export MODEL=jerryzh168/Phi-4-mini-instruct-AWQ-INT4
+lm_eval --model hf --model_args pretrained=$MODEL --tasks mmlu --device cuda:0 --batch_size 8
+```
+</details>
+
+
+
+
+# Peak Memory Usage
+
+## Results
+
+| Benchmark        |                |                                |
+|------------------|----------------|--------------------------------|
+|                  | microsoft/Phi-4-mini-instruct   | jerryzh168/Phi-4-mini-instruct-AWQ-INT4              |
+| Peak Memory (GB) | To be filled   | To be filled (?% reduction)    |
+
+
+
+<details>
+<summary> Reproduce Peak Memory Usage Results </summary>
+
+We can use the following code to get a sense of peak memory usage during inference:
 
-<!-- Provide a quick summary of what the model is/does. -->
+```Py
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer, TorchAoConfig
 
+# use "microsoft/Phi-4-mini-instruct" or "jerryzh168/Phi-4-mini-instruct-AWQ-INT4"
+model_id = "jerryzh168/Phi-4-mini-instruct-AWQ-INT4"
+quantized_model = AutoModelForCausalLM.from_pretrained(model_id, device_map="auto", torch_dtype=torch.bfloat16)
+tokenizer = AutoTokenizer.from_pretrained(model_id)
 
+torch.cuda.reset_peak_memory_stats()
 
-## Model Details
+prompt = "Hey, are you conscious? Can you talk to me?"
+messages = [
+    {
+        "role": "system",
+        "content": "",
+    },
+    {"role": "user", "content": prompt},
+]
+templated_prompt = tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True,
+)
+print("Prompt:", prompt)
+print("Templated prompt:", templated_prompt)
+inputs = tokenizer(
+    templated_prompt,
+    return_tensors="pt",
+).to("cuda")
+generated_ids = quantized_model.generate(**inputs, max_new_tokens=128)
+output_text = tokenizer.batch_decode(
+    generated_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False
+)
+print("Response:", output_text[0][len(prompt):])
 
-### Model Description
+mem = torch.cuda.max_memory_reserved() / 1e9
+print(f"Peak Memory Usage: {mem:.02f} GB")
+```
 
-<!-- Provide a longer summary of what this model is. -->
+</details>
 
-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. -->
+# Model Performance
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+## Results (A100 machine)
+| Benchmark (Latency)              |                |                          |
+|----------------------------------|----------------|--------------------------|
+|                                  | microsoft/Phi-4-mini-instruct   | jerryzh168/Phi-4-mini-instruct-AWQ-INT4        |
+| latency (batch_size=1)           | ?s          | ?s (?x speedup)    |
 
-## Uses
+<details>
+<summary> Reproduce Model Performance Results </summary>
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+## Setup
 
-### Direct Use
+Get vllm source code:
+```Shell
+git clone [email protected]:vllm-project/vllm.git
+```
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+Install vllm
+```
+VLLM_USE_PRECOMPILED=1 pip install --editable .
+```
 
-[More Information Needed]
+Run the benchmarks under `vllm` root folder:
 
-### Downstream Use [optional]
+## benchmark_latency
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+### baseline
+```Shell
+export MODEL=microsoft/Phi-4-mini-instruct
+python benchmarks/benchmark_latency.py --input-len 256 --output-len 256 --model $MODEL --batch-size 1
+```
 
-[More Information Needed]
+### AWQ-INT4
+```Shell
+export MODEL=jerryzh168/Phi-4-mini-instruct-AWQ-INT4
+VLLM_DISABLE_COMPILE_CACHE=1 python benchmarks/benchmark_latency.py --input-len 256 --output-len 256 --model $MODEL --batch-size 1
+```
 
-### Out-of-Scope Use
+## benchmark_serving
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+We benchmarked the throughput in a serving environment.
 
-[More Information Needed]
+Download sharegpt dataset:
 
-## Bias, Risks, and Limitations
+```Shell
+wget https://huggingface.co/datasets/anon8231489123/ShareGPT_Vicuna_unfiltered/resolve/main/ShareGPT_V3_unfiltered_cleaned_split.json
+```
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[More Information Needed]
 
-### Recommendations
+Other datasets can be found in: https://github.com/vllm-project/vllm/tree/main/benchmarks
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+Note: you can change the number of prompts to be benchmarked with `--num-prompts` argument for `benchmark_serving` script.
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+### baseline
+Server:
+```Shell
+export MODEL=microsoft/Phi-4-mini-instruct
+vllm serve $MODEL --tokenizer $MODEL -O3
+```
 
-## How to Get Started with the Model
+Client:
+```Shell
+export MODEL=microsoft/Phi-4-mini-instruct
+python benchmarks/benchmark_serving.py --backend vllm --dataset-name sharegpt --tokenizer $MODEL --dataset-path ./ShareGPT_V3_unfiltered_cleaned_split.json --model $MODEL --num-prompts 1
+```
 
-Use the code below to get started with the model.
+### AWQ-INT4
+Server:
+```Shell
+export MODEL=jerryzh168/Phi-4-mini-instruct-AWQ-INT4
+VLLM_DISABLE_COMPILE_CACHE=1 vllm serve $MODEL --tokenizer $MODEL -O3 --pt-load-map-location cuda:0
+```
 
-[More Information Needed]
+Client:
+```Shell
+export MODEL=jerryzh168/Phi-4-mini-instruct-AWQ-INT4
+python benchmarks/benchmark_serving.py --backend vllm --dataset-name sharegpt --tokenizer $MODEL --dataset-path ./ShareGPT_V3_unfiltered_cleaned_split.json --model $MODEL --num-prompts 1
+```
+</details>
 
-## 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]
+# Paper: TorchAO: PyTorch-Native Training-to-Serving Model Optimization
+The model's quantization is powered by **TorchAO**, a framework presented in the paper [TorchAO: PyTorch-Native Training-to-Serving Model Optimization](https://huggingface.co/papers/2507.16099).
 
-### Training Procedure
+**Abstract:** We present TorchAO, a PyTorch-native model optimization framework leveraging quantization and sparsity to provide an end-to-end, training-to-serving workflow for AI models. TorchAO supports a variety of popular model optimization techniques, including FP8 quantized training, quantization-aware training (QAT), post-training quantization (PTQ), and 2:4 sparsity, and leverages a novel tensor subclass abstraction to represent a variety of widely-used, backend agnostic low precision data types, including INT4, INT8, FP8, MXFP4, MXFP6, and MXFP8. TorchAO integrates closely with the broader ecosystem at each step of the model optimization pipeline, from pre-training (TorchTitan) to fine-tuning (TorchTune, Axolotl) to serving (HuggingFace, vLLM, SGLang, ExecuTorch), connecting an otherwise fragmented space in a single, unified workflow. TorchAO has enabled recent launches of the quantized Llama 3.2 1B/3B and LlamaGuard3-8B models and is open-source at this https URL .
 
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
+# Resources
+*   **Official TorchAO GitHub Repository:** [https://github.com/pytorch/ao](https://github.com/pytorch/ao)
+*   **TorchAO Documentation:** [https://docs.pytorch.org/ao/stable/index.html](https://docs.pytorch.org/ao/stable/index.html)
 
-#### Preprocessing [optional]
 
-[More Information Needed]
+# Disclaimer
+PyTorch has not performed safety evaluations or red teamed the quantized models. Performance characteristics, outputs, and behaviors may differ from the original models. Users are solely responsible for selecting appropriate use cases, evaluating and mitigating for accuracy, safety, and fairness, ensuring security, and complying with all applicable laws and regulations.
 
-
-#### 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]
+Nothing contained in this Model Card should be interpreted as or deemed a restriction or modification to the licenses the models are released under, including any limitations of liability or disclaimers of warranties provided therein.