Standardize interface, better default args for org-to-json.py script

- Remove non-standard, unnecessary argument for org-directory
  Pass path each file in org-files and org-files-filter argument directly
- Allow shorthand -i, -o for input files, output files
- Default to compress, unless user explicitly specifies not to
This commit is contained in:
Debanjum Singh Solanky
2021-08-16 11:17:42 -07:00
parent 7547e90745
commit 8b29e272d3
2 changed files with 42 additions and 30 deletions

View File

@@ -22,10 +22,8 @@ Setup
Generate compressed JSONL from specified org-mode files
```sh
python3 processor/org-mode/org-to-jsonl.py \
--org-files "Schedule.org" "Incoming.org" \
--org-directory "~/Notes" \
--org-files "~/Notes/Schedule.org" "~/Notes/Incoming.org" \
--jsonl-file ".notes.jsonl" \
--compress \
--verbose
```
@@ -33,7 +31,10 @@ Run
---
Load ML model, generate embeddings and expose API interface to run user queries on above org-mode files
```sh
python3 main.py -j .notes.jsonl.gz -e .notes_embeddings.pt
python3 main.py \
--jsonl-file .notes.jsonl.gz \
--embeddings-file .notes_embeddings.pt \
--verbose
```
Use
@@ -48,9 +49,9 @@ Use
- *Call Semantic Search via Python Script Directly*
```sh
python3 search_types/asymmetric.py \
-j .notes.jsonl.gz \
-e .notes_embeddings.pt \
-n 5 \
--jsonl-file .notes.jsonl.gz \
--embeddings-file .notes_embeddings.pt \
--results-count 5 \
--verbose \
--interactive
```