besaleli commited on
Commit
69c6f6c
·
verified ·
1 Parent(s): 37a8298

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +33 -0
README.md ADDED
@@ -0,0 +1,33 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ tags:
3
+ - encoderfile
4
+ ---
5
+ # Encoderfile Models
6
+
7
+ Pre-built [encoderfiles](https://github.com/mozilla-ai/encoderfile) for popular Hugging Face embedding models — self-contained executables that run as embedding servers with no Python or ML dependencies required.
8
+
9
+ ## Available Models
10
+
11
+ | Model | Details |
12
+ |---|---|
13
+ | [sentence-transformers/all-MiniLM-L6-v2](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/) | 384-dim, English sentence embeddings |
14
+
15
+ More models coming soon.
16
+
17
+ ## Usage
18
+
19
+ Each model directory contains platform-specific binaries. Download the one for your platform, make it executable, and run:
20
+
21
+ ```bash
22
+ # Serve embeddings over HTTP
23
+ ./all-MiniLM-L6-v2.aarch64-apple-darwin.encoderfile serve
24
+
25
+ # Or infer directly from the CLI
26
+ ./all-MiniLM-L6-v2.aarch64-apple-darwin.encoderfile infer "this is a test"
27
+ ```
28
+
29
+ If you don't see the model you want or are using an exotic architecture, check out our guide on [Building encoderfiles](https://mozilla-ai.github.io/encoderfile/reference/building/).
30
+
31
+ ## About
32
+
33
+ These encoderfiles are built and published by [mozilla-ai](https://huggingface.co/mozilla-ai) using the [Encoderfile](https://github.com/mozilla-ai/encoderfile) tool. To build your own, see the [Encoderfile documentation](https://mozilla-ai.github.io/encoderfile).