mirror of
https://github.com/khoj-ai/khoj.git
synced 2024-11-30 19:03:01 +01:00
Update Readme Instructions to use Desktop GUI to configure App
- Configure app using the configure screen during first run. No config file args required to be passed via CLI by users - Update instructions to copy khoj_sample.yml to default app configure file location and edit that. Instead of editing the khoj_sample.yml directly in source
This commit is contained in:
parent
b8913476ba
commit
342c72b156
1 changed files with 20 additions and 20 deletions
32
Readme.md
32
Readme.md
|
@ -69,16 +69,14 @@
|
||||||
pip install khoj-assistant
|
pip install khoj-assistant
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Configure
|
### 2. Start App
|
||||||
- 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`, `processor` sub-sections irrelevant for your use-case
|
|
||||||
|
|
||||||
### 3. Run
|
|
||||||
``` shell
|
``` shell
|
||||||
khoj -c=config/khoj_sample.yml -vv
|
khoj
|
||||||
```
|
```
|
||||||
Loads ML model, generates embeddings and exposes API to search notes, images, transactions etc specified in config YAML
|
|
||||||
|
### 3. Configure
|
||||||
|
1. Enable content types and point to files to search in the First Run Screen that pops up on app start*
|
||||||
|
2. Click configure* and wait. The app will load ML model, generates embeddings and exposes the search API
|
||||||
|
|
||||||
## Use
|
## Use
|
||||||
|
|
||||||
|
@ -88,7 +86,7 @@
|
||||||
- [Install](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#installation) [khoj.el](./src/interface/emacs/khoj.el)
|
- [Install](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#installation) [khoj.el](./src/interface/emacs/khoj.el)
|
||||||
- Run `M-x khoj <user-query>`
|
- Run `M-x khoj <user-query>`
|
||||||
- **Khoj via API**
|
- **Khoj via API**
|
||||||
- See [Khoj FastAPI Docs](http://localhost:8000/docs), [Khoj FastAPI ReDocs](http://localhost:8000/redocs)
|
- See the FastAPI [Swagger Docs](http://localhost:8000/docs), [ReDocs](http://localhost:8000/redocs)
|
||||||
|
|
||||||
## Upgrade
|
## Upgrade
|
||||||
``` shell
|
``` shell
|
||||||
|
@ -98,7 +96,7 @@ pip install --upgrade khoj-assistant
|
||||||
## Troubleshoot
|
## Troubleshoot
|
||||||
|
|
||||||
- Symptom: Errors out complaining about Tensors mismatch, null etc
|
- Symptom: Errors out complaining about Tensors mismatch, null etc
|
||||||
- Mitigation: Delete `content-type` > `image` section from `khoj_sample.yml`
|
- Mitigation: Disable `image` section on the desktop GUI
|
||||||
|
|
||||||
- Symptom: Errors out with \"Killed\" in error message in Docker
|
- Symptom: Errors out with \"Killed\" in error message in Docker
|
||||||
- Fix: Increase RAM available to Docker Containers in Docker Settings
|
- Fix: Increase RAM available to Docker Containers in Docker Settings
|
||||||
|
@ -108,7 +106,7 @@ pip install --upgrade khoj-assistant
|
||||||
|
|
||||||
- The experimental [chat](localhost:8000/chat) API endpoint uses the [OpenAI API](https://openai.com/api/)
|
- The experimental [chat](localhost:8000/chat) API endpoint uses the [OpenAI API](https://openai.com/api/)
|
||||||
- It is disabled by default
|
- It is disabled by default
|
||||||
- To use it add your `openai-api-key` to config.yml
|
- To use it add your `openai-api-key` via the app configure screen
|
||||||
|
|
||||||
## Performance
|
## Performance
|
||||||
|
|
||||||
|
@ -140,13 +138,14 @@ pip install --upgrade khoj-assistant
|
||||||
pip install -e .
|
pip install -e .
|
||||||
```
|
```
|
||||||
##### 2. Configure
|
##### 2. Configure
|
||||||
- Set `input-files` or `input-filter` in each relevant `content-type` section of `khoj_sample.yml`
|
- Copy the `config/khoj_sample.yml` to `~/.khoj/khoj.yml`
|
||||||
|
- Set `input-files` or `input-filter` in each relevant `content-type` section of `~/.khoj/khoj.yml`
|
||||||
- Set `input-directories` field in `image` `content-type` section
|
- Set `input-directories` field in `image` `content-type` section
|
||||||
- Delete `content-type`, `processor` sub-sections irrelevant for your use-case
|
- Delete `content-type` and `processor` sub-section(s) irrelevant for your use-case
|
||||||
|
|
||||||
##### 3. Run
|
##### 3. Run
|
||||||
``` shell
|
``` shell
|
||||||
khoj -c=config/khoj_sample.yml -vv
|
khoj -vv
|
||||||
```
|
```
|
||||||
Load ML model, generate embeddings and expose API to query notes, images, transactions etc specified in config YAML
|
Load ML model, generate embeddings and expose API to query notes, images, transactions etc specified in config YAML
|
||||||
|
|
||||||
|
@ -209,13 +208,14 @@ docker-compose build --pull
|
||||||
```
|
```
|
||||||
|
|
||||||
##### 3. Configure
|
##### 3. Configure
|
||||||
- Set `input-files` or `input-filter` in each relevant `content-type` section of `khoj_sample.yml`
|
- Copy the `config/khoj_sample.yml` to `~/.khoj/khoj.yml`
|
||||||
|
- Set `input-files` or `input-filter` in each relevant `content-type` section of `~/.khoj/khoj.yml`
|
||||||
- Set `input-directories` field in `image` `content-type` section
|
- Set `input-directories` field in `image` `content-type` section
|
||||||
- Delete `content-type`, `processor` sub-sections irrelevant for your use-case
|
- Delete `content-type`, `processor` sub-sections irrelevant for your use-case
|
||||||
|
|
||||||
##### 4. Run
|
##### 4. Run
|
||||||
``` shell
|
``` shell
|
||||||
python3 -m src.main config/khoj_sample.yml -vv
|
python3 -m src.main -vv
|
||||||
```
|
```
|
||||||
Load ML model, generate embeddings and expose API to query notes, images, transactions etc specified in config YAML
|
Load ML model, generate embeddings and expose API to query notes, images, transactions etc specified in config YAML
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue