sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-11-27 17:35:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Reduce indentation from 4 to 2 in Readme.md.

Browse source 
Prevent everything looking like code blocks due to 4 space indentations
This commit is contained in:
Debanjum Singh Solanky 2021-08-15 22:56:36 -07:00
parent 636b6195cc
commit ae15e429b5
1 changed files with 36 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
README.md
View file

@ -6,54 +6,54 @@ All data is processed locally. User can interface with semantic-search app via [
Dependencies Dependencies
---- ----
- Python3 - Python3
- [Miniconda](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) - [Miniconda](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links)
Install Install
--- ---
```sh ```sh
git clone https://github.com/debanjum/semantic-search && cd semantic-search git clone https://github.com/debanjum/semantic-search && cd semantic-search
conda env create -f environment.yml conda env create -f environment.yml
conda activate semantic-search conda activate semantic-search
``` ```
Setup Setup
--- ---
Generate compressed JSONL from specified org-mode files Generate compressed JSONL from specified org-mode files
```sh ```sh
python3 processor/org-mode/org-to-jsonl.py \ python3 processor/org-mode/org-to-jsonl.py \
--org-files "Schedule.org" "Incoming.org" \ --org-files "Schedule.org" "Incoming.org" \
--org-directory "~/Notes" \ --org-directory "~/Notes" \
--jsonl-file ".data/notes.jsonl" \ --jsonl-file ".data/notes.jsonl" \
--compress \ --compress \
--verbose --verbose
``` ```
Run Run
--- ---
Load ML model, generate embeddings and expose API interface to run user queries on above org-mode files Load ML model, generate embeddings and expose API interface to run user queries on above org-mode files
```sh ```sh
python3 main.py -j .data/notes.jsonl.gz -e .data/notes_embeddings.pt python3 main.py -j .data/notes.jsonl.gz -e .data/notes_embeddings.pt
``` ```
Use Use
--- ---
- *Calls Semantic Search via Emacs* - *Calls Semantic Search via Emacs*
- `M-x semantic-search "<users-query"` - `M-x semantic-search "<user-query>"`
- `C-c C-s` - `C-c C-s`
- *Call Semantic Search via API* - *Call Semantic Search via API*
- `GET` [http://localhost:8000/search?q="What is the meaning of life"](http://localhost:8000/search?q=%22what%20is%20the%20meaning%20of%20life%22) - `GET` [http://localhost:8000/search?q="What is the meaning of life"](http://localhost:8000/search?q=%22what%20is%20the%20meaning%20of%20life%22)
- *Call Semantic Search via Python Script Directly* - *Call Semantic Search via Python Script Directly*
```sh ```sh
python3 search_types/asymmetric.py \ python3 search_types/asymmetric.py \
-j .data/notes.jsonl.gz \ -j .data/notes.jsonl.gz \
-e .data/notes_embeddings.pt \ -e .data/notes_embeddings.pt \
-n 5 \ -n 5 \
--verbose \ --verbose \
--interactive --interactive
``` ```
Acknowledgments Acknowledgments
-- --