Create README.md

README.md

@@ -0,0 +1,27 @@
+---
+license: mit
+---
+This is the ONNX variant of the [bge-base-en-v1.5](https://huggingface.co/BAAI/bge-base-en-v1.5) model for embeddings created with the [DeepSparse Optimum](https://github.com/neuralmagic/optimum-deepsparse) integration.
+
+For ONNX export, run:
+
+```bash
+pip install git+https://github.com/neuralmagic/optimum-deepsparse.git
+```
+
+```python
+from optimum.deepsparse import DeepSparseModelForFeatureExtraction
+from transformers.onnx.utils import get_preprocessor
+from pathlib import Path
+
+model_id = "BAAI/bge-base-en-v1.5"
+
+# load model and convert to onnx
+model = DeepSparseModelForFeatureExtraction.from_pretrained(model_id, export=True)
+tokenizer = get_preprocessor(model_id)
+
+# save onnx checkpoint and tokenizer
+onnx_path = Path("dense-bge-base-en-v1.5")
+model.save_pretrained(onnx_path)
+tokenizer.save_pretrained(onnx_path)
+```