sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-11-23 15:38:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Add Section for Development with Pip

Browse source
This commit is contained in:
Debanjum Singh Solanky 2022-08-05 04:59:52 +03:00
parent d1fe6353b5
commit 0098f27f0c
1 changed files with 23 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
Readme.md
View file

@ -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)
- Sven Marnach for [PyExifTool](https://github.com/smarnach/pyexiftool/blob/master/exiftool.py)