Update Readme. No separate SETUP step required. Simpler RUN step

- Setup now happens on first run of application
- Embeddings can now be regenerated without killing app by calling API
This commit is contained in:
Debanjum Singh Solanky 2021-08-16 19:18:48 -07:00
parent 95bf26a7f2
commit 79aff85fcb

View file

@ -17,24 +17,11 @@ Install
conda activate semantic-search conda activate semantic-search
``` ```
Setup
---
Generate compressed JSONL from specified org-mode files
```sh
python3 processor/org-mode/org-to-jsonl.py \
--input-files ~/Notes/Schedule.org ~/Notes/Incoming.org \
--output-file .notes.jsonl.gz \
--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 to query specified org-mode files
```sh ```sh
python3 main.py \ python3 main.py --input-files ~/Notes/Schedule.org ~/Notes/Incoming.org --verbose
--compressed-jsonl .notes.jsonl.gz \
--embeddings .notes_embeddings.pt \
--verbose
``` ```
Use Use
@ -43,8 +30,10 @@ Use
- [Install](https://github.com/debanjum/semantic-search/tree/master/interface/emacs#installation) [semantic-search.el](./interface/emacs/semantic-search.el) - [Install](https://github.com/debanjum/semantic-search/tree/master/interface/emacs#installation) [semantic-search.el](./interface/emacs/semantic-search.el)
- Run `M-x semantic-search "<user-query>"` or Call `C-c C-s` - Run `M-x semantic-search "<user-query>"` or Call `C-c C-s`
- *Call Semantic Search via API* - *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) - Query: `GET` [http://localhost:8000/search?q="What is the meaning of life"](http://localhost:8000/search?q=%22what%20is%20the%20meaning%20of%20life%22)
- Regenerate Embeddings: `GET` [http://localhost:8000/regenerate](http://localhost:8000/regenerate)
- [Semantic Search API Docs](http://localhost:8000/docs)
- *Call Semantic Search via Python Script Directly* - *Call Semantic Search via Python Script Directly*
```sh ```sh