From 0098f27f0cf045a4b5f7edb22b0d917e4ee24678 Mon Sep 17 00:00:00 2001 From: Debanjum Singh Solanky Date: Fri, 5 Aug 2022 04:59:52 +0300 Subject: [PATCH] Add Section for Development with Pip --- Readme.md | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/Readme.md b/Readme.md index 6eae68bb..60994467 100644 --- a/Readme.md +++ b/Readme.md @@ -69,7 +69,7 @@ ### 2. Configure - Set `input-files` or `input-filter` in each relevant `content-type` section of [khoj_sample.yml](./config/khoj_sample.yml) - Set `input-directories` field in `content-type.image` section - - Delete `content-type` sections irrelevant for your use-case + - Delete `content-type`, `processor` sub-sections irrelevant for your use-case ### 3. Run ``` shell @@ -109,6 +109,25 @@ pip install --upgrade khoj-assistant ## Development ### Setup +#### Using Pip +1. Install Khoj + ``` shell + git clone https://github.com/debanjum/khoj && cd khoj + python -m venv .venv && source .venv/bin/activate + pip install + ``` + +3. Configure + - Set `input-files` or `input-filter` in each relevant `content-type` section of `khoj_sample.yml` + - Set `input-directories` field in `image` `content-type` section + - Delete `content-type`, `processor` sub-sections irrelevant for your use-case + +4. Run + ``` shell + khoj config/khoj_sample.yml -vv + ``` + Load ML model, generate embeddings and expose API to query notes, images, transactions etc specified in config YAML + #### Using Docker 1. Clone @@ -147,13 +166,13 @@ docker-compose up -d 3. Configure - Set `input-files` or `input-filter` in each relevant `content-type` section of `khoj_sample.yml` - Set `input-directories` field in `image` `content-type` section - - Delete `content-type` sections irrelevant for your use-case + - Delete `content-type`, `processor` sub-sections irrelevant for your use-case 4. Run Load ML model, generate embeddings and expose API to query notes, images, transactions etc specified in config YAML ``` shell - python3 -m src.main -c=config/khoj_sample.yml -vv + python3 -m src.main config/khoj_sample.yml -vv ``` ### Upgrade @@ -218,4 +237,4 @@ pytest - Charles Cave for [OrgNode Parser](http://members.optusnet.com.au/~charles57/GTD/orgnode.html) - [Org.js](https://mooz.github.io/org-js/) to render Org-mode results on the Web interface - [Markdown-it](https://github.com/markdown-it/markdown-it) to render Markdown results on the Web interface -- Sven Marnach for [PyExifTool](https://github.com/smarnach/pyexiftool/blob/master/exiftool.py) \ No newline at end of file +- Sven Marnach for [PyExifTool](https://github.com/smarnach/pyexiftool/blob/master/exiftool.py)