Updates to model card (#1)

Browse files

- Updates to model card (eb70f627c826699aae13b7360e348dd7f54b0d14)

Co-authored-by: Scott Roy <[email protected]>

Files changed (1) hide show

README.md +109 -194

README.md CHANGED Viewed

@@ -3,197 +3,112 @@ 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]

 tags: []
 ---
+# Quantization Recipe
+We used following code to get the quantized model:
+```
+model_id = "microsoft/Phi-4-mini-instruct"
+from transformers import (
+    AutoModelForCausalLM,
+    AutoProcessor,
+    AutoTokenizer,
+)
+from torchao.quantization.quant_api import (
+    Int8DynamicActivationIntxWeightConfig,
+    MappingType,
+    quantize_,
+)
+from torchao.quantization.granularity import PerGroup
+import torch
+model = AutoModelForCausalLM.from_pretrained(
+    model_id, torch_dtype="auto", device_map="auto"
+)
+linear_config = Int8DynamicActivationIntxWeightConfig(
+    weight_dtype=torch.int4,
+    weight_granularity=PerGroup(32),
+    weight_mapping_type=MappingType.SYMMETRIC,
+)
+quantize_(
+	model,
+    linear_config,
+)
+state_dict = model.state_dict()
+torch.save(state_dict, "phi4-mini-8dq4w.pt")
+```
+# Model Quality
+We rely on [lm-evaluation-harness](https://github.com/EleutherAI/lm-evaluation-harness) to evaluate the quality of the quantized model.
+# baseline
+```
+lm_eval --model hf --model_args pretrained=microsoft/Phi-4-mini-instruct --tasks hellaswag --device cuda:0 --batch_size 8
+```
+# 8dq4w
+```
+import lm_eval
+from lm_eval import evaluator
+from lm_eval.utils import (
+    make_table,
+)
+# model is after calling quantize_ as we do in the recipe
+# quantize_(
+#	model,
+#    linear_config,
+#)
+lm_eval_model = lm_eval.models.huggingface.HFLM(pretrained=model, batch_size=8)
+results = evaluator.simple_evaluate(
+    lm_eval_model, tasks=["hellaswag"], device="cuda:0", batch_size="auto"
+)
+print(make_table(results))
+```
+| Benchmark                        |             |                   |
+|----------------------------------|-------------|-------------------|
+|                                  | Phi-4 mini-Ins | phi4-mini-8dq4w |
+| **Popular aggregated benchmark** |             |                   |
+| **Reasoning**                    |             |                   |
+| HellaSwag                        | 54.57        | 53.19            |
+| **Multilingual**                 |             |                   |
+| **Math**                         |             |                   |
+| **Overall**                      | **TODO**    | **TODO**          |
+# Exporting to ExecuTorch
+Exporting to ExecuTorch requires you clone and install [ExecuTorch](https://github.com/pytorch/executorch).
+## Convert quantized checkpoint to ExecuTorch's format
+python -m executorch.examples.models.phi_4_mini.convert_weights phi4-mini-8dq4w.pt phi4-mini-8dq4w-converted.pt
+## Export to an ExecuTorch *.pte with XNNPACK
+PARAMS="executorch/examples/models/phi_4_mini/config.json"
+python -m executorch.examples.models.llama.export_llama \
+  --model "phi_4_mini" \
+  --checkpoint "phi4-mini-8dq4w-converted.pt" \
+  --params "$PARAMS" \
+  -kv \
+  --use_sdpa_with_kv_cache \
+  -X \
+  --metadata '{"get_bos_id":128000, "get_eos_ids":[128009, 128001]}' \
+  --output_name="phi4-mini-8dq4w.pte"
+## Run model with pybindings
+export TOKENIZER="/path/to/tokenizer.json"
+export TOKENIZER_CONFIG="/path/to/tokenizer_config.json"
+export PROMPT="<|system|><|end|><|user|>What is in a california roll?<|end|><|assistant|>"
+python -m executorch.examples.models.llama.runner.native \
+  --model phi_4_mini \
+  --pte phi4-mini-8dq4w.pte \
+  -kv \
+  --tokenizer ${TOKENIZER} \
+  --tokenizer_config ${TOKENIZER_CONFIG} \
+  --prompt "${PROMPT}" \
+  --params "${PARAMS}" \
+  --max_len 128 \
+  --temperature 0