Add model card: document base model mixedbread-ai/mxbai-edge-colbert-v0-32m
Browse files
README.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
base_model: mixedbread-ai/mxbai-edge-colbert-v0-32m
|
| 3 |
+
license: apache-2.0
|
| 4 |
+
library_name: coreml
|
| 5 |
+
pipeline_tag: sentence-similarity
|
| 6 |
+
tags:
|
| 7 |
+
- coreml
|
| 8 |
+
- colbert
|
| 9 |
+
- multi-vector
|
| 10 |
+
- late-interaction
|
| 11 |
+
- feature-extraction
|
| 12 |
+
- sentence-similarity
|
| 13 |
+
- apple
|
| 14 |
+
- on-device
|
| 15 |
+
---
|
| 16 |
+
|
| 17 |
+
# MXBAIEdgeColbert (Core ML)
|
| 18 |
+
|
| 19 |
+
A [Core ML](https://developer.apple.com/documentation/coreml) export of
|
| 20 |
+
[`mixedbread-ai/mxbai-edge-colbert-v0-32m`](https://huggingface.co/mixedbread-ai/mxbai-edge-colbert-v0-32m)
|
| 21 |
+
for on-device ColBERT late-interaction (multi-vector) encoding on Apple platforms.
|
| 22 |
+
|
| 23 |
+
## Base model
|
| 24 |
+
|
| 25 |
+
- **Base model:** [`mixedbread-ai/mxbai-edge-colbert-v0-32m`](https://huggingface.co/mixedbread-ai/mxbai-edge-colbert-v0-32m)
|
| 26 |
+
|
| 27 |
+
This repository contains only the compiled Core ML encoder (`MXBAIEdgeColbert.mlmodelc`).
|
| 28 |
+
All weights are derived from the base model above; no additional training was performed.
|
| 29 |
+
|
| 30 |
+
## What was exported
|
| 31 |
+
|
| 32 |
+
The exported program wraps the base transformer plus its three ColBERT `Dense`
|
| 33 |
+
projection layers (384 → 768 → 768 → 64, no bias / no activation), producing
|
| 34 |
+
per-token embeddings that are L2-normalized and masked by the attention mask.
|
| 35 |
+
|
| 36 |
+
| Property | Value |
|
| 37 |
+
| --- | --- |
|
| 38 |
+
| Inputs | `input_ids` and `attention_mask`, `int32`, static shape `(1, 256)` |
|
| 39 |
+
| Output | `token_embeddings` (per-token, dim 64, L2-normalized, padding zeroed) |
|
| 40 |
+
| Compute precision | `float16` |
|
| 41 |
+
| Minimum deployment target | iOS 18 / macOS 15 |
|
| 42 |
+
|
| 43 |
+
Tokenization and the ColBERT `[Q]` / `[D]` prefixing and skiplist masking are
|
| 44 |
+
performed by the host application; this model performs encoding only.
|
| 45 |
+
|
| 46 |
+
## Usage
|
| 47 |
+
|
| 48 |
+
Intended for use as the encoder in an on-device ColBERT/PLAID retrieval
|
| 49 |
+
pipeline. Load the compiled model with Core ML, feed padded `int32`
|
| 50 |
+
`input_ids` / `attention_mask`, and read `token_embeddings`.
|
| 51 |
+
|
| 52 |
+
## License
|
| 53 |
+
|
| 54 |
+
Released under the Apache-2.0 license, following the base model.
|