klbr/khoj
1
0
Fork 0
mirror of https://github.com/khoaliber/khoj.git synced 2026-03-08 05:39:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix command to run Khoj in Readme Documentation

Browse Source
This commit is contained in:
Debanjum Singh Solanky
2022-08-13 14:35:32 +03:00
parent 3300378804
commit 36dc2f619a
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
Readme.md
View File

@@ -34,7 +34,7 @@
## Features ## Features
- **Natural**: Advanced Natural language understanding using Transformer based ML Models - **Natural**: Advanced natural language understanding using Transformer based ML Models
- **Local**: Your personal data stays local. All search, indexing is done on your machine[\*](https://github.com/debanjum/khoj#miscellaneous) - **Local**: Your personal data stays local. All search, indexing is done on your machine[\*](https://github.com/debanjum/khoj#miscellaneous)
- **Incremental**: Incremental search for a fast, search-as-you-type experience - **Incremental**: Incremental search for a fast, search-as-you-type experience
- **Pluggable**: Modular architecture makes it easy to plug in new data sources, frontends and ML models - **Pluggable**: Modular architecture makes it easy to plug in new data sources, frontends and ML models
@@ -75,7 +75,7 @@
### 3. Run ### 3. Run
``` shell ``` shell
khoj config/khoj_sample.yml -vv khoj -c=config/khoj_sample.yml -vv
``` ```
Loads ML model, generates embeddings and exposes API to search notes, images, transactions etc specified in config YAML Loads ML model, generates embeddings and exposes API to search notes, images, transactions etc specified in config YAML
@@ -135,7 +135,7 @@ pip install --upgrade khoj-assistant
##### 1. Install ##### 1. Install
``` shell ``` shell
git clone https://github.com/debanjum/khoj && cd khoj git clone https://github.com/debanjum/khoj && cd khoj
python -m venv .venv && source .venv/bin/activate python3 -m venv .venv && source .venv/bin/activate
pip install -e . pip install -e .
``` ```
##### 2. Configure ##### 2. Configure
@@ -145,7 +145,7 @@ pip install --upgrade khoj-assistant
##### 3. Run ##### 3. Run
``` shell ``` shell
khoj config/khoj_sample.yml -vv khoj -c=config/khoj_sample.yml -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
@@ -153,9 +153,11 @@ pip install --upgrade khoj-assistant
```shell ```shell
# To Upgrade To Latest Stable Release # To Upgrade To Latest Stable Release
# Maps to the latest tagged version of khoj on master branch
pip install --upgrade khoj-assistant pip install --upgrade khoj-assistant
# To Upgrade To Latest Pre-Release # To Upgrade To Latest Pre-Release
# Maps to the latest commit on the master branch
pip install --upgrade --pre khoj-assistant pip install --upgrade --pre khoj-assistant
# To Upgrade To Specific Development Release. # To Upgrade To Specific Development Release.