Add Doppel model card
Browse files
README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: apache-2.0
|
| 3 |
+
library_name: coreml
|
| 4 |
+
pipeline_tag: feature-extraction
|
| 5 |
+
base_model: jinaai/jina-embeddings-v2-small-en
|
| 6 |
+
inference: false
|
| 7 |
+
tags:
|
| 8 |
+
- coreml
|
| 9 |
+
- apple-silicon
|
| 10 |
+
- macos
|
| 11 |
+
- on-device
|
| 12 |
+
- text-embeddings
|
| 13 |
+
- doppel
|
| 14 |
+
---
|
| 15 |
+
|
| 16 |
+
# Doppel embeddings companion
|
| 17 |
+
|
| 18 |
+
This repository is Doppel's distribution channel for an app-specific Core ML
|
| 19 |
+
conversion of
|
| 20 |
+
[`jinaai/jina-embeddings-v2-small-en`](https://huggingface.co/jinaai/jina-embeddings-v2-small-en).
|
| 21 |
+
It supports Doppel's private, on-device search index.
|
| 22 |
+
|
| 23 |
+
## Intended use
|
| 24 |
+
|
| 25 |
+
These artifacts are intended to be downloaded, verified, and invoked by
|
| 26 |
+
Doppel on Apple-silicon Macs running macOS 15 or later. Indexed content and
|
| 27 |
+
generated embeddings remain on the user's device.
|
| 28 |
+
|
| 29 |
+
This is not a standalone embedding distribution or a supported developer API.
|
| 30 |
+
The repository does not include Doppel's text preparation, pooling,
|
| 31 |
+
normalization, indexing, retrieval, or compatibility logic. Results produced
|
| 32 |
+
outside that contract are not supported or comparable to Doppel search. For
|
| 33 |
+
general-purpose use, start with the upstream model.
|
| 34 |
+
|
| 35 |
+
## Artifact and integrity notes
|
| 36 |
+
|
| 37 |
+
The compiled Core ML components are modified from the upstream checkpoint for
|
| 38 |
+
Doppel's bounded runtime shapes. `jina_coreml_manifest.json` is the
|
| 39 |
+
authoritative artifact inventory and records the integrity hashes checked by
|
| 40 |
+
the app.
|
| 41 |
+
|
| 42 |
+
The repository contains no user documents, embeddings, search indexes,
|
| 43 |
+
queries, prompts, telemetry, or other customer data.
|
| 44 |
+
|
| 45 |
+
## Limitations
|
| 46 |
+
|
| 47 |
+
Embedding similarity is not a factuality, authorization, or safety signal.
|
| 48 |
+
Retrieval quality varies with language, document structure, terminology, and
|
| 49 |
+
the surrounding search pipeline.
|
| 50 |
+
|
| 51 |
+
## License and attribution
|
| 52 |
+
|
| 53 |
+
The upstream model is provided under the
|
| 54 |
+
[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
|
| 55 |
+
This converted distribution remains subject to the applicable upstream terms.
|
| 56 |
+
Doppel provides no support or warranty for use outside the Doppel app.
|