do-me commited on
Commit
21ae564
·
verified ·
1 Parent(s): 73383b2

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +10 -5
README.md CHANGED
@@ -36,13 +36,18 @@ This is the HF data repo for indexed texts, ready-to-import in SemanticFinder. T
36
  | 0.07 | Universal Declaration of Human Rights | United Nations | 1948 | en | https://do-me.github.io/SemanticFinder/?hf=Universal_Declaration_of_Human_Rights_0a7da79a | TaylorAI/gte-tiny | True | \nArticle | Regex | 8623 | 63 | | | | | 5 | 109 | 30 articles | https://www.un.org/en/about-us/universal-declaration-of-human-rights | Universal_Declaration_of_Human_Rights_0a7da79a.json.gz |
37
 
38
  ### Example
39
- Once loaded in SemanticFinder it takes less than 3 seconds to search through the whole bible! Try it out.
40
 
41
- 1. Copy the URL, e.g. `https://huggingface.co/datasets/do-me/SemanticFinder/resolve/main/king-james-bible_gte-tiny_q_200-chars_2-dec.json.gz` to the "Import URL" field and load it. Depending on your connection this might be instant or take a couple of seconds.
42
- 2. Once loaded, simply enter something you want to search for and hit "Find". The result appear instantly.
43
 
44
  ### Create SemanticFinder files
45
 
46
  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.
47
- 2. Export the index file. Note that you have the freedom to reduce decimals to reduce file size; usually 5 is more than enough.
48
- 3. Create a PR here if you want to see it added in the official collection! Just make sure to run `create_meta_data_csv_md.py` once to update the csv/md file. For now, the `readme.md` table here needs to be updated with the meta_data.md manually.
 
 
 
 
 
 
36
  | 0.07 | Universal Declaration of Human Rights | United Nations | 1948 | en | https://do-me.github.io/SemanticFinder/?hf=Universal_Declaration_of_Human_Rights_0a7da79a | TaylorAI/gte-tiny | True | \nArticle | Regex | 8623 | 63 | | | | | 5 | 109 | 30 articles | https://www.un.org/en/about-us/universal-declaration-of-human-rights | Universal_Declaration_of_Human_Rights_0a7da79a.json.gz |
37
 
38
  ### Example
39
+ Once loaded in SemanticFinder it takes around 2 seconds to search through the whole bible! Try it out.
40
 
41
+ 1. Click on one of the example URLs of your choice.
42
+ 2. Once the index loaded, simply enter something you want to search for and hit "Find". The results will appear almost instantly.
43
 
44
  ### Create SemanticFinder files
45
 
46
  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.
47
+ 2. Add the metadata (so other people can find your index) and export the file. Note that you have the freedom to reduce decimals to reduce file size; usually 3 is more than enough depending on the model. Less than 3 will also do in most cases but if you need highest accuracy go with 5 or more.
48
+ 3. Create a PR here if you want to see it added in the official collection! Just make sure to run `create_meta_data_csv_md.py` once to update the csv/md file. For now, the `readme.md` table here needs to be updated with the meta_data.md manually.
49
+
50
+ ### Privacy
51
+ - This repo is public and shares documents of public interest or documents in the public domain.
52
+ - If you have sensitive documents you can still create the index with SemanticFinder and use it only locally.
53
+ Either you can load the index from disk each time or you host it in your local network and add the URL in SemanticFinder.