zeroshot commited on
Commit
1429ba1
1 Parent(s): 0316ca6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +4 -20
README.md CHANGED
@@ -387,20 +387,9 @@ model-index:
387
 
388
  # bge-large-en-v1.5-sparse
389
 
390
- This is the sparsified ONNX variant of the [bge-large-en-v1.5](https://huggingface.co/BAAI/bge-large-en-v1.5) embeddings model created with [DeepSparse Optimum](https://github.com/neuralmagic/optimum-deepsparse) for ONNX export/inference pipeline and Neural Magic's [Sparsify](https://github.com/neuralmagic/sparsify) for one-shot quantization (INT8) and unstructured pruning (50%).
391
 
392
- Model achieves 98% accuracy recovery on the STSB validation dataset vs. [dense ONNX variant](https://huggingface.co/zeroshot/bge-large-en-v1.5-dense).
393
-
394
- Current list of sparse and quantized bge ONNX models:
395
-
396
- | Links | Sparsification Method |
397
- | --------------------------------------------------------------------------------------------------- | ---------------------- |
398
- | [zeroshot/bge-large-en-v1.5-sparse](https://huggingface.co/zeroshot/bge-large-en-v1.5-sparse) | Quantization (INT8) & 50% Pruning |
399
- | [zeroshot/bge-large-en-v1.5-quant](https://huggingface.co/zeroshot/bge-large-en-v1.5-quant) | Quantization (INT8) |
400
- | [zeroshot/bge-base-en-v1.5-sparse](https://huggingface.co/zeroshot/bge-base-en-v1.5-sparse) | Quantization (INT8) & 50% Pruning |
401
- | [zeroshot/bge-base-en-v1.5-quant](https://huggingface.co/zeroshot/bge-base-en-v1.5-quant) | Quantization (INT8) |
402
- | [zeroshot/bge-small-en-v1.5-sparse](https://huggingface.co/zeroshot/bge-small-en-v1.5-sparse) | Quantization (INT8) & 50% Pruning |
403
- | [zeroshot/bge-small-en-v1.5-quant](https://huggingface.co/zeroshot/bge-small-en-v1.5-quant) | Quantization (INT8) |
404
 
405
  ```bash
406
  pip install -U deepsparse-nightly[sentence_transformers]
@@ -408,7 +397,7 @@ pip install -U deepsparse-nightly[sentence_transformers]
408
 
409
  ```python
410
  from deepsparse.sentence_transformers import DeepSparseSentenceTransformer
411
- model = DeepSparseSentenceTransformer('zeroshot/bge-large-en-v1.5-sparse', export=False)
412
 
413
  # Our sentences we like to encode
414
  sentences = ['This framework generates embeddings for each input sentence',
@@ -425,9 +414,4 @@ for sentence, embedding in zip(sentences, embeddings):
425
  print("")
426
  ```
427
 
428
- For further details regarding DeepSparse & Sentence Transformers integration, refer to the [DeepSparse README](https://github.com/neuralmagic/deepsparse/tree/main/src/deepsparse/sentence_transformers).
429
-
430
-
431
- For general questions on these models and sparsification methods, reach out to the engineering team on our [community Slack](https://join.slack.com/t/discuss-neuralmagic/shared_invite/zt-q1a1cnvo-YBoICSIw3L1dmQpjBeDurQ).
432
-
433
- ![;)](https://media.giphy.com/media/bYg33GbNbNIVzSrr84/giphy-downsized-large.gif)
 
387
 
388
  # bge-large-en-v1.5-sparse
389
 
390
+ ## Usage
391
 
392
+ This is the sparse ONNX variant of the [bge-small-en-v1.5](https://huggingface.co/BAAI/bge-small-en-v1.5) embeddings model accelerated with [Sparsify](https://github.com/neuralmagic/sparsify) for quantization/pruning and [DeepSparseSentenceTransformers](https://github.com/neuralmagic/deepsparse/tree/main/src/deepsparse/sentence_transformers) for inference.
 
 
 
 
 
 
 
 
 
 
 
393
 
394
  ```bash
395
  pip install -U deepsparse-nightly[sentence_transformers]
 
397
 
398
  ```python
399
  from deepsparse.sentence_transformers import DeepSparseSentenceTransformer
400
+ model = DeepSparseSentenceTransformer('neuralmagic/bge-large-en-v1.5-sparse', export=False)
401
 
402
  # Our sentences we like to encode
403
  sentences = ['This framework generates embeddings for each input sentence',
 
414
  print("")
415
  ```
416
 
417
+ For general questions on these models and sparsification methods, reach out to the engineering team on our [community Slack](https://join.slack.com/t/discuss-neuralmagic/shared_invite/zt-q1a1cnvo-YBoICSIw3L1dmQpjBeDurQ).