mirror of
https://github.com/khoaliber/khoj.git
synced 2026-03-04 05:39:06 +00:00
1ba7fa66e5
- Add instruction to using Docker with README - Use the ./tests/data folder in docker_sample_conifg.yml so it can work right away for users
87 lines
3.4 KiB
Org Mode
87 lines
3.4 KiB
Org Mode
[[https://github.com/debanjum/semantic-search/actions/workflows/build.yml/badge.svg]]
|
|
|
|
* Semantic Search
|
|
/Allow natural language search on user content like notes, images, transactions using transformer based models/
|
|
|
|
All data is processed locally. User can interface with semantic-search app via [[./src/interface/emacs/semantic-search.el][Emacs]], API or Commandline
|
|
|
|
** Setup
|
|
|
|
*** Setup using Docker
|
|
|
|
**** 1. Clone Repository
|
|
#+begin_src shell
|
|
git clone https://github.com/debanjum/semantic-search && cd semantic-search
|
|
#+end_src
|
|
|
|
**** 2. Configure
|
|
Add Content Directories for Semantic Search to Docker-Compose
|
|
Update [[./docker-compose.yml][docker-compose.yml]] to mount your images, org-mode notes, ledger/beancount directories
|
|
If required, edit config settings in [[./docker_sample_config.yml][docker_sample_config.yml]].
|
|
|
|
**** 3. Run
|
|
#+begin_src shell
|
|
docker-compose up -d
|
|
#+end_src
|
|
|
|
*** Setup on Local Machine
|
|
|
|
**** 1. Install Dependencies
|
|
1. Install Python3 [Required[
|
|
2. [[https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html][Install Conda]] [Required]
|
|
3. Install Exiftool [Optional]
|
|
#+begin_src shell
|
|
sudo apt-get -y install libimage-exiftool-perl
|
|
#+end_src
|
|
|
|
**** 2. Install Semantic Search
|
|
#+begin_src shell
|
|
git clone https://github.com/debanjum/semantic-search && cd semantic-search
|
|
conda env create -f environment.yml
|
|
conda activate semantic-search
|
|
#+end_src
|
|
|
|
**** 3. Configure
|
|
Configure application search types and their underlying data source/files in ~sample_config.yml~
|
|
Use the ~sample_config.yml~ as reference
|
|
|
|
**** 4. Run
|
|
Load ML model, generate embeddings and expose API to query notes, images, transactions etc specified in config YAML
|
|
|
|
#+begin_src shell
|
|
python3 -m src.main -c=sample_config.yml -vv
|
|
#+end_src
|
|
|
|
** Use
|
|
- *Semantic Search via Emacs*
|
|
- [[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 <user-query>~
|
|
|
|
- *Semantic Search via API*
|
|
- Query: ~GET~ [[http://localhost:8000/search?q=%22what%20is%20the%20meaning%20of%20life%22][http://localhost:8000/search?q="What is the meaning of life"&t=notes]]
|
|
- Regenerate Embeddings: ~GET~ [[http://localhost:8000/regenerate][http://localhost:8000/regenerate]]
|
|
- [[http://localhost:8000/docs][Semantic Search API Docs]]
|
|
|
|
- *UI to Edit Config*
|
|
- [[https://localhost:8000/ui][Config UI]]
|
|
|
|
** Upgrade
|
|
|
|
*** Using Docker
|
|
#+begin_src shell
|
|
docker-compose up
|
|
#+end_src
|
|
|
|
*** On Local Machine
|
|
#+begin_src shell
|
|
cd semantic-search
|
|
git pull origin master
|
|
conda env update -f environment.yml
|
|
conda activate semantic-search
|
|
#+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]]
|
|
- Charles Cave for [[http://members.optusnet.com.au/~charles57/GTD/orgnode.html][OrgNode Parser]]
|
|
- Sven Marnach for [[https://github.com/smarnach/pyexiftool/blob/master/exiftool.py][PyExifTool]] |