From af9660f28ea49fcdda903a8751cb70f95e38a3a9 Mon Sep 17 00:00:00 2001 From: Debanjum Singh Solanky Date: Tue, 17 Aug 2021 01:25:12 -0700 Subject: [PATCH] Move application files under src directory. Update Readmes - Remove callign asymmetric search script directly command. It doesn't work anymore on calling directly due to internal package import issues --- README.org | 16 +++------------- {processor => src}/__init__.py | 0 {interface => src/interface}/emacs/README.org | 0 .../interface}/emacs/semantic-search.el | 0 main.py => src/main.py | 0 .../org_mode => src/processor}/__init__.py | 0 .../processor/org_mode}/__init__.py | 0 .../processor}/org_mode/org_to_jsonl.py | 0 {processor => src/processor}/org_mode/orgnode.py | 0 {utils => src/search_type}/__init__.py | 0 {search_type => src/search_type}/asymmetric.py | 0 {search_type => src/search_type}/image-search.py | 0 {search_type => src/search_type}/symmetric.py | 0 src/utils/__init__.py | 0 {utils => src/utils}/helpers.py | 0 {utils => src/utils}/install.py | 0 16 files changed, 3 insertions(+), 13 deletions(-) rename {processor => src}/__init__.py (100%) rename {interface => src/interface}/emacs/README.org (100%) rename {interface => src/interface}/emacs/semantic-search.el (100%) rename main.py => src/main.py (100%) rename {processor/org_mode => src/processor}/__init__.py (100%) rename {search_type => src/processor/org_mode}/__init__.py (100%) rename {processor => src/processor}/org_mode/org_to_jsonl.py (100%) rename {processor => src/processor}/org_mode/orgnode.py (100%) rename {utils => src/search_type}/__init__.py (100%) rename {search_type => src/search_type}/asymmetric.py (100%) rename {search_type => src/search_type}/image-search.py (100%) rename {search_type => src/search_type}/symmetric.py (100%) create mode 100644 src/utils/__init__.py rename {utils => src/utils}/helpers.py (100%) rename {utils => src/utils}/install.py (100%) diff --git a/README.org b/README.org index 3e0b479d..04dbbbaf 100644 --- a/README.org +++ b/README.org @@ -1,7 +1,7 @@ * Semantic Search /Allow natural language search on user content like notes, images using transformer based models/ - All data is processed locally. User can interface with semantic-search app via [[./interface/emacs/semantic-search.el][Emacs]], API or Commandline + All data is processed locally. User can interface with semantic-search app via [[./src/interface/emacs/semantic-search.el][Emacs]], API or Commandline ** Dependencies - Python3 @@ -18,12 +18,12 @@ Load ML model, generate embeddings and expose API to query specified org-mode files #+begin_src shell - python3 main.py --input-files ~/Notes/Schedule.org ~/Notes/Incoming.org --verbose + python3 src/main.py --input-files ~/Notes/Schedule.org ~/Notes/Incoming.org --verbose #+end_src ** Use - *Semantic Search via Emacs* - - [[https://github.com/debanjum/semantic-search/tree/master/interface/emacs#installation][Install]] [[./interface/emacs/semantic-search.el][semantic-search.el]] + - [[https://github.com/debanjum/semantic-search/tree/master/src/interface/emacs#installation][Install]] [[./src/interface/emacs/semantic-search.el][semantic-search.el]] - Run ~M-x semantic-search ~ or Call ~C-c C-s~ - *Semantic Search via API* @@ -31,16 +31,6 @@ - Regenerate Embeddings: ~GET~ [[http://localhost:8000/regenerate][http://localhost:8000/regenerate]] - [[http://localhost:8000/docs][Semantic Search API Docs]] - - *Call Semantic Search via Python Script Directly* - #+begin_src shell - python3 search_types/asymmetric.py \ - --compressed-jsonl .notes.jsonl.gz \ - --embeddings .notes_embeddings.pt \ - --results-count 5 \ - --verbose \ - --interactive - #+end_src - ** Acknowledgments - [[https://huggingface.co/sentence-transformers/msmarco-MiniLM-L-6-v3][MiniLM Model]] for Asymmetric Text Search. See [[https://www.sbert.net/examples/applications/retrieve_rerank/README.html][SBert Documentation]] - [[https://github.com/openai/CLIP][OpenAI CLIP Model]] for Image Search. See [[https://www.sbert.net/examples/applications/image-search/README.html][SBert Documentation]] diff --git a/processor/__init__.py b/src/__init__.py similarity index 100% rename from processor/__init__.py rename to src/__init__.py diff --git a/interface/emacs/README.org b/src/interface/emacs/README.org similarity index 100% rename from interface/emacs/README.org rename to src/interface/emacs/README.org diff --git a/interface/emacs/semantic-search.el b/src/interface/emacs/semantic-search.el similarity index 100% rename from interface/emacs/semantic-search.el rename to src/interface/emacs/semantic-search.el diff --git a/main.py b/src/main.py similarity index 100% rename from main.py rename to src/main.py diff --git a/processor/org_mode/__init__.py b/src/processor/__init__.py similarity index 100% rename from processor/org_mode/__init__.py rename to src/processor/__init__.py diff --git a/search_type/__init__.py b/src/processor/org_mode/__init__.py similarity index 100% rename from search_type/__init__.py rename to src/processor/org_mode/__init__.py diff --git a/processor/org_mode/org_to_jsonl.py b/src/processor/org_mode/org_to_jsonl.py similarity index 100% rename from processor/org_mode/org_to_jsonl.py rename to src/processor/org_mode/org_to_jsonl.py diff --git a/processor/org_mode/orgnode.py b/src/processor/org_mode/orgnode.py similarity index 100% rename from processor/org_mode/orgnode.py rename to src/processor/org_mode/orgnode.py diff --git a/utils/__init__.py b/src/search_type/__init__.py similarity index 100% rename from utils/__init__.py rename to src/search_type/__init__.py diff --git a/search_type/asymmetric.py b/src/search_type/asymmetric.py similarity index 100% rename from search_type/asymmetric.py rename to src/search_type/asymmetric.py diff --git a/search_type/image-search.py b/src/search_type/image-search.py similarity index 100% rename from search_type/image-search.py rename to src/search_type/image-search.py diff --git a/search_type/symmetric.py b/src/search_type/symmetric.py similarity index 100% rename from search_type/symmetric.py rename to src/search_type/symmetric.py diff --git a/src/utils/__init__.py b/src/utils/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/utils/helpers.py b/src/utils/helpers.py similarity index 100% rename from utils/helpers.py rename to src/utils/helpers.py diff --git a/utils/install.py b/src/utils/install.py similarity index 100% rename from utils/install.py rename to src/utils/install.py