Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,30 @@
+---
+base_model: tiiuae/Falcon3-3B-Instruct
+language:
+- en
+- fr
+- es
+- pt
+library_name: transformers
+license: other
+license_name: falcon-llm-license
+license_link: https://falconllm.tii.ae/falcon-terms-and-conditions.html
+tags:
+- falcon3
+- openvino
+- nncf
+- 4-bit
+base_model_relation: quantized
+---
+
+This model is a quantized version of [`tiiuae/Falcon3-3B-Instruct`](https://huggingface.co/tiiuae/Falcon3-3B-Instruct) and is converted to the OpenVINO format. This model was obtained via the [nncf-quantization](https://huggingface.co/spaces/echarlaix/nncf-quantization) space with [optimum-intel](https://github.com/huggingface/optimum-intel).
+First make sure you have `optimum-intel` installed:
+```bash
+pip install optimum[openvino]
+```
+To load your model you can do as follows:
+```python
+from optimum.intel import OVModelForCausalLM
+model_id = "AIFunOver/Falcon3-3B-Instruct-openvino-4bit"
+model = OVModelForCausalLM.from_pretrained(model_id)
+```