mirror of
https://github.com/khoj-ai/khoj.git
synced 2024-11-27 17:35:07 +01:00
Fix and Update Readme. Delete old Demo from Repository
This commit is contained in:
parent
c4fd661909
commit
3000b91297
2 changed files with 59 additions and 55 deletions
24
Readme.md
24
Readme.md
|
@ -57,7 +57,7 @@ https://user-images.githubusercontent.com/6413477/184735169-92c78bf1-d827-4663-9
|
|||
|
||||
### Analysis
|
||||
|
||||
- The top result does not have any words used in the query
|
||||
- The results do not have any words used in the query
|
||||
- *Based on the top result it seems the re-ranking model understands that Emacs is an editor?*
|
||||
- The results incrementally update as the query is entered
|
||||
- The results are re-ranked, for better accuracy, once user hits enter
|
||||
|
@ -72,21 +72,21 @@ https://user-images.githubusercontent.com/6413477/184735169-92c78bf1-d827-4663-9
|
|||
|
||||
## Setup
|
||||
### 1. Install
|
||||
|
||||
```shell
|
||||
pip install khoj-assistant
|
||||
```
|
||||
|
||||
### 2. Start App
|
||||
|
||||
```shell
|
||||
khoj
|
||||
```
|
||||
|
||||
### 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
|
||||
|
||||
![](https://github.com/debanjum/khoj/blob/master/docs/desktop_interface.png)
|
||||
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 expose the search API
|
||||
|
||||
## Use
|
||||
|
||||
|
@ -96,9 +96,10 @@ https://user-images.githubusercontent.com/6413477/184735169-92c78bf1-d827-4663-9
|
|||
- [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>`
|
||||
- **Khoj via API**
|
||||
- See the FastAPI [Swagger Docs](http://localhost:8000/docs), [ReDocs](http://localhost:8000/redocs)
|
||||
- See the Khoj FastAPI [Swagger Docs](http://localhost:8000/docs), [ReDocs](http://localhost:8000/redocs)
|
||||
|
||||
## Upgrade
|
||||
|
||||
```shell
|
||||
pip install --upgrade khoj-assistant
|
||||
```
|
||||
|
@ -106,17 +107,17 @@ pip install --upgrade khoj-assistant
|
|||
## Troubleshoot
|
||||
|
||||
- Symptom: Errors out complaining about Tensors mismatch, null etc
|
||||
- Mitigation: Disable `image` section on the desktop GUI
|
||||
|
||||
- Mitigation: Disable `image` search on the desktop GUI
|
||||
- Symptom: Errors out with \"Killed\" in error message in Docker
|
||||
- Fix: Increase RAM available to Docker Containers in Docker Settings
|
||||
- Refer: [StackOverflow Solution](https://stackoverflow.com/a/50770267), [Configure Resources on Docker for Mac](https://docs.docker.com/desktop/mac/#resources)
|
||||
|
||||
## Miscellaneous
|
||||
|
||||
- The experimental [chat](localhost:8000/chat) API endpoint uses the [OpenAI API](https://openai.com/api/)
|
||||
- The beta [chat](http://localhost:8000/beta/chat) and [search](http://localhost:8000/beta/search) API endpoints use [OpenAI API](https://openai.com/api/)
|
||||
- It is disabled by default
|
||||
- To use it add your `openai-api-key` via the app configure screen
|
||||
- Warning: *If you use the above beta APIs, your query and top result(s) will be sent to OpenAI for processing*
|
||||
|
||||
## Performance
|
||||
|
||||
|
@ -142,18 +143,22 @@ pip install --upgrade khoj-assistant
|
|||
### Setup
|
||||
#### Using Pip
|
||||
##### 1. Install
|
||||
|
||||
```shell
|
||||
git clone https://github.com/debanjum/khoj && cd khoj
|
||||
python3 -m venv .venv && source .venv/bin/activate
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
##### 2. Configure
|
||||
|
||||
- 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
|
||||
- Delete `content-type` and `processor` sub-section(s) irrelevant for your use-case
|
||||
|
||||
##### 3. Run
|
||||
|
||||
```shell
|
||||
khoj -vv
|
||||
```
|
||||
|
@ -239,7 +244,6 @@ conda activate khoj
|
|||
```
|
||||
|
||||
### Test
|
||||
|
||||
```shell
|
||||
pytest
|
||||
```
|
||||
|
|
BIN
docs/demo.mp4
BIN
docs/demo.mp4
Binary file not shown.
Loading…
Reference in a new issue