Skip to content

Commit

Permalink
docs: Support notice in README.md (#123)
Browse files Browse the repository at this point in the history
Signed-off-by: Anush008 <[email protected]>
  • Loading branch information
Anush008 committed Nov 15, 2024
1 parent 474d4e6 commit a3794de
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 13 deletions.
20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,23 +158,17 @@ println!("Rerank result: {:?}", results);

Alternatively, local model files can be used for inference via the `try_new_from_user_defined(...)` methods of respective structs.

## 🚒 Under the hood
## ✊ Support

### Why fast?
To support the library, please consider donating to our primary upstream dependency, [`ort`](https://github.com/pykeio/ort?tab=readme-ov-file#-sponsor-ort) - The Rust wrapper for the ONNX runtime.

It's important we justify the "fast" in FastEmbed. FastEmbed is fast because:
## ⚙️ Under the hood

1. Quantized model weights
2. ONNX Runtime which allows for inference on CPU, GPU, and other dedicated runtimes
It's important we justify the "fast" in FastEmbed. FastEmbed is fast because of:

### Why light?

1. No hidden dependencies via Huggingface Transformers

### Why accurate?

1. Better than OpenAI Ada-002
2. Top of the Embedding leaderboards e.g. [MTEB](https://huggingface.co/spaces/mteb/leaderboard)
1. Quantized model weights.
2. ONNX Runtime which allows for inference on CPU, GPU, and other dedicated runtimes.
3. No hidden dependencies via Huggingface Transformers.

## 📄 LICENSE

Expand Down
1 change: 1 addition & 0 deletions tests/embeddings.rs
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,7 @@ fn test_rerank() {
});
}

#[ignore]
#[test]
fn test_user_defined_reranking_large_model() {
// Setup model to download from Hugging Face
Expand Down

0 comments on commit a3794de

Please sign in to comment.