lukemerrick commited on
Commit
349781b
·
verified ·
1 Parent(s): b76f1da

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +25 -0
README.md CHANGED
@@ -5,3 +5,28 @@ language:
5
 
6
  # Luxical One
7
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5
 
6
  # Luxical One
7
 
8
+ This is a small lexical-dense text embedding model distilled for English-language symmetrical full-document text similarity and classification applications from [`Snowflake/snowflake-arctic-embed-m-v2.0`](https://huggingface.co/Snowflake/snowflake-arctic-embed-m-v2.0).
9
+
10
+ ## Quickstart -- Transformers
11
+
12
+ Luxical One includes a basic HuggingFace integration that supports model inference. GPU inference is not supported (GPU "acceleration" would not provide a meaningful boost on most systems due to how fast and small the model is).
13
+
14
+ You must have the `luxical` package installed to run this model, and you must trust the remote code bundled with the model. Currently only cpython versions 3.11-3.13 and macos/linux operating systems are supported.
15
+
16
+ ``` shell
17
+ pip install luxical
18
+ ```
19
+
20
+ ``` python
21
+ from transformers import AutoModel
22
+ from pathlib import Path
23
+
24
+ # Load from the Huggingface Hub.
25
+ hub_model = AutoModel.from_pretrained(
26
+ "datologyai/luxical-one",
27
+ trust_remote_code=True,
28
+ )
29
+
30
+ # Embed some text.
31
+ emb = local_model(["Luxical integrates with Huggingface."]).embeddings
32
+ ```