Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,32 @@
|
|
| 1 |
---
|
| 2 |
license: mit
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: mit
|
| 3 |
+
tags:
|
| 4 |
+
- transformers.js
|
| 5 |
+
- transformers
|
| 6 |
+
- semanticsearch
|
| 7 |
+
- SemanticFinder
|
| 8 |
---
|
| 9 |
+
<p align="center">
|
| 10 |
+
<a href="https://do-me.github.io/SemanticFinder/">
|
| 11 |
+
<img src="https://github.com/do-me/SemanticFinder/assets/47481567/4522ab9d-08f4-4f4c-92db-dbf14ccb2b70" width="320" alt="SemanticFinder">
|
| 12 |
+
</a>
|
| 13 |
+
<h1 align="center">Frontend-only live semantic search with transformers.js</h1>
|
| 14 |
+
</p>
|
| 15 |
+
|
| 16 |
+
- **App: [SemanticFinder](https://do-me.github.io/SemanticFinder/)**
|
| 17 |
+
|
| 18 |
+
- **GitHub: [do-me/SemanticFinder](https://github.com/do-me/SemanticFinder)**
|
| 19 |
+
|
| 20 |
+
This is the HF data repo for indexed texts, ready-to-import in SemanticFinder. The files contain the original text, text chunks and their embeddings.
|
| 21 |
+
|
| 22 |
+
### Example
|
| 23 |
+
Once loaded in SemanticFinder it takes less than 3 seconds to search through the whole bible! Try it out.
|
| 24 |
+
|
| 25 |
+
1. Copy the URL to the "Import URL" field and load it. Depending on your connection this might be instant or take a couple of seconds.
|
| 26 |
+
2. Once loaded, simply enter something you want to search for and hit "Find". The result appear instantly.
|
| 27 |
+
|
| 28 |
+
### Create SemanticFinder files
|
| 29 |
+
|
| 30 |
+
1. Just use SemanticFinder as usual and run at least one search so that the index is created. This might take a while if your input is large. E.g. indexing the bible with 200 chars results in ~23k embeddings and takes 15-30 mins with a quantized gte-tiny model.
|
| 31 |
+
2. Export the index file. Note that you have the freedom to reduce decimals to reduce file size; usually 5 is more than enough.
|
| 32 |
+
3. Create a PR here if you want to see it added in the official collection!
|