Rename khoj config yml file to follow more specific khoj*.yml pattern

- That is, sample_config.yml is renamed to khoj_sample.yml
- This makes the application config filename less generic,
  more easily identifiable with the application
- Update docs, app accordingly
This commit is contained in:
Debanjum Singh Solanky 2022-08-03 12:06:55 +03:00
parent 48681644e9
commit a4eb55dd00
5 changed files with 14 additions and 14 deletions

2
.gitignore vendored
View file

@ -11,4 +11,4 @@ src/.data
/build/
/dist/
/khoj_assistant.egg-info/
/config/*.yml
/config/khoj*.yml

View file

@ -70,7 +70,7 @@ git clone https://github.com/debanjum/khoj && cd khoj
### 2. Configure
- **Required**: Update [docker-compose.yml](./docker-compose.yml) to mount your images, (org-mode or markdown) notes and beancount directories
- **Optional**: Edit application configuration in [sample_config.yml](./config/sample_config.yml)
- **Optional**: Edit application configuration in [khoj_sample.yml](./config/khoj_sample.yml)
### 3. Run
@ -105,7 +105,7 @@ docker-compose build --pull
- 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)
- Symptom: Errors out complaining about Tensors mismatch, null etc
- Mitigation: Delete content-type > image section from `docker_sample_config.yml`
- Mitigation: Delete content-type > image section from `khoj_sample.yml`
## Miscellaneous
@ -133,15 +133,15 @@ docker-compose build --pull
```
3. Configure
- Configure files/directories to search in `content-type` section of `sample_config.yml`
- To run application on test data, update file paths containing `/data/` to `tests/data/` in `sample_config.yml`
- Configure files/directories to search in `content-type` section of `khoj_sample.yml`
- To run application on test data, update file paths containing `/data/` to `tests/data/` in `khoj_sample.yml`
- Example replace `/data/notes/*.org` with `tests/data/notes/*.org`
4. Run
Load ML model, generate embeddings and expose API to query notes, images, transactions etc specified in config YAML
``` shell
khoj -c=config/sample_config.yml -vv
khoj -c=config/khoj_sample.yml -vv
```
#### Using Conda
@ -161,15 +161,15 @@ docker-compose build --pull
```
3. Configure
- Configure files/directories to search in `content-type` section of `sample_config.yml`
- To run application on test data, update file paths containing `/data/` to `tests/data/` in `sample_config.yml`
- Configure files/directories to search in `content-type` section of `khoj_sample.yml`
- To run application on test data, update file paths containing `/data/` to `tests/data/` in `khoj_sample.yml`
- Example replace `/data/notes/*.org` with `tests/data/notes/*.org`
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/sample_config.yml -vv
python3 -m src.main -c=config/khoj_sample.yml -vv
```
### Upgrade On Local Machine

View file

@ -34,4 +34,4 @@ services:
limits:
memory: 8g
# Use 0.0.0.0 to explicitly set the host ip for the service on the container. https://pythonspeed.com/articles/docker-connection-refused/
command: --host="0.0.0.0" --port=8000 -c=config/sample_config.yml -vv
command: --host="0.0.0.0" --port=8000 -c=config/khoj_sample.yml -vv

View file

@ -28,7 +28,7 @@ git clone https://github.com/debanjum/khoj && cd khoj
mount your images, (org-mode or markdown) notes and beancount
directories
- \[Optional\] Edit application configuration in
[sample~config~.yml](./config/sample_config.yml)
[khoj_sample.yml](./config/khoj_sample.yml)
### 3. Run
@ -113,9 +113,9 @@ docker-compose build --pull
3. 3\. Configure
- Configure files/directories to search in `content-type` section
of `sample_config.yml`
of `khoj_sample.yml`
- To run application on test data, update file paths containing
`/data/` to `tests/data/` in `sample_config.yml`
`/data/` to `tests/data/` in `khoj_sample.yml`
- Example replace `/data/notes/*.org` with
`tests/data/notes/*.org`
@ -125,7 +125,7 @@ docker-compose build --pull
images, transactions etc specified in config YAML
``` shell
python3 -m src.main -c=config/sample_config.yml -vv
python3 -m src.main -c=config/khoj_sample.yml -vv
```
### Upgrade On Local Machine