Upload folder using huggingface_hub (#2)

- 9fdd1c7d2568649727ce6c76f9bcb31c2bd149e01b8312297ded4c179186cc1b (6921ea84839857a791b4add6f9387f4b5b9f0a2b)

README.md

@@ -1,6 +1,6 @@
 ---
 thumbnail: "https://assets-global.website-files.com/646b351987a8d8ce158d1940/64ec9e96b4334c0e1ac41504_Logo%20with%20white%20text.svg"
-base_model: microsoft/Phi-3-mini-128k-instruct
+base_model: PrunaAI/microsoft-Phi-3-mini-128k-instruct-HQQ-2bit-smashed
 metrics:
 - memory_disk
 - memory_inference
@@ -38,9 +38,9 @@ tags:
 ![image info](./plots.png)
 
 **Frequently Asked Questions**
-- ***How does the compression work?*** The model is compressed with hqq.
+- ***How does the compression work?*** The model is compressed with [.
 - ***How does the model quality change?*** The quality of the model output might vary compared to the base model.
-- ***How is the model efficiency evaluated?*** These results were obtained on NVIDIA A100-PCIE-40GB with configuration described in `model/smash_config.json` and are obtained after a hardware warmup. The smashed model is directly compared to the original base model. Efficiency results may vary in other settings (e.g. other hardware, image size, batch size, ...). We recommend to directly run them in the use-case conditions to know if the smashed model can benefit you.
+- ***How is the model efficiency evaluated?*** These results were obtained on HARDWARE_NAME with configuration described in `model/smash_config.json` and are obtained after a hardware warmup. The smashed model is directly compared to the original base model. Efficiency results may vary in other settings (e.g. other hardware, image size, batch size, ...). We recommend to directly run them in the use-case conditions to know if the smashed model can benefit you.
 - ***What is the model format?*** We use safetensors.
 - ***What calibration data has been used?*** If needed by the compression method, we used WikiText as the calibration data.
 - ***What is the naming convention for Pruna Huggingface models?*** We take the original model name and append "turbo", "tiny", or "green" if the smashed model has a measured inference speed, inference memory, or inference energy consumption which is less than 90% of the original base model.
@@ -52,22 +52,18 @@ tags:
 
 You can run the smashed model with these steps:
 
-0. Check requirements from the original repo microsoft/Phi-3-mini-128k-instruct installed. In particular, check python, cuda, and transformers versions.
+0. Check requirements from the original repo PrunaAI/microsoft-Phi-3-mini-128k-instruct-HQQ-2bit-smashed installed. In particular, check python, cuda, and transformers versions.
 1. Make sure that you have installed quantization related packages.
     ```bash
-    pip install hqq
+    REQUIREMENTS_INSTRUCTIONS
     ```
 2. Load & run the model.
     ```python 
    from transformers import AutoModelForCausalLM, AutoTokenizer
-    from hqq.engine.hf import HQQModelForCausalLM
- from hqq.models.hf.base import AutoHQQHFModel
-
-   try:
-     model = HQQModelForCausalLM.from_quantized("PrunaAI/microsoft-Phi-3-mini-128k-instruct-HQQ-2bit-smashed", device_map='auto')
-    except: 
-     model = AutoHQQHFModel.from_quantized("PrunaAI/microsoft-Phi-3-mini-128k-instruct-HQQ-2bit-smashed")
-   tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3-mini-128k-instruct")
+   IMPORTS
+
+   MODEL_LOAD
+   tokenizer = AutoTokenizer.from_pretrained("PrunaAI/microsoft-Phi-3-mini-128k-instruct-HQQ-2bit-smashed")
     
    input_ids = tokenizer("What is the color of prunes?,", return_tensors='pt').to(model.device)["input_ids"]
     
@@ -81,7 +77,7 @@ The configuration info are in `smash_config.json`.
 
 ## Credits & License
 
-The license of the smashed model follows the license of the original model. Please check the license of the original model microsoft/Phi-3-mini-128k-instruct before using this model which provided the base model. The license  of the `pruna-engine` is [here](https://pypi.org/project/pruna-engine/) on Pypi.
+The license of the smashed model follows the license of the original model. Please check the license of the original model PrunaAI/microsoft-Phi-3-mini-128k-instruct-HQQ-2bit-smashed before using this model which provided the base model. The license  of the `pruna-engine` is [here](https://pypi.org/project/pruna-engine/) on Pypi.
 
 ## Want to compress other models?
 

results.json

@@ -1,30 +1,17 @@
 {
-    "base_current_gpu_type": "NVIDIA A100-PCIE-40GB",
-    "base_current_gpu_total_memory": 40339.3125,
-    "base_token_generation_latency_sync": 80.28141708374024,
-    "base_token_generation_latency_async": 80.70033676922321,
-    "base_token_generation_throughput_sync": 0.012456182717314473,
-    "base_token_generation_throughput_async": 0.012391522018794985,
-    "base_token_generation_CO2_emissions": null,
-    "base_token_generation_energy_consumption": null,
-    "base_inference_latency_sync": 80.46366806030274,
-    "base_inference_latency_async": 83.66153240203857,
-    "base_inference_throughput_sync": 0.012427969344506634,
-    "base_inference_throughput_async": 0.011952924734804799,
-    "base_inference_CO2_emissions": null,
-    "base_inference_energy_consumption": null,
-    "smashed_current_gpu_type": "NVIDIA A100-PCIE-40GB",
-    "smashed_current_gpu_total_memory": 40339.3125,
-    "smashed_token_generation_latency_sync": 145.91746520996094,
-    "smashed_token_generation_latency_async": 145.90322263538837,
-    "smashed_token_generation_throughput_sync": 0.0068531892228329075,
-    "smashed_token_generation_throughput_async": 0.006853858207772397,
-    "smashed_token_generation_CO2_emissions": null,
-    "smashed_token_generation_energy_consumption": null,
-    "smashed_inference_latency_sync": 143.4565643310547,
-    "smashed_inference_latency_async": 147.71199226379395,
-    "smashed_inference_throughput_sync": 0.006970751074815233,
-    "smashed_inference_throughput_async": 0.006769931030475394,
-    "smashed_inference_CO2_emissions": null,
-    "smashed_inference_energy_consumption": null
+    "current_gpu_type": "NVIDIA A100-PCIE-40GB",
+    "current_gpu_total_memory": 40339.3125,
+    "perplexity": 73023.5234375,
+    "token_generation_latency_sync": 117.78927917480469,
+    "token_generation_latency_async": 116.79135784506798,
+    "token_generation_throughput_sync": 0.008489736986300376,
+    "token_generation_throughput_async": 0.00856227736753066,
+    "token_generation_CO2_emissions": null,
+    "token_generation_energy_consumption": null,
+    "inference_latency_sync": 171.31888427734376,
+    "inference_latency_async": 167.85626411437988,
+    "inference_throughput_sync": 0.0058370681330210256,
+    "inference_throughput_async": 0.0059574779962848715,
+    "inference_CO2_emissions": null,
+    "inference_energy_consumption": null
 }