Improve Khoj Intro text. Move Run Unit Test Section under Developement Heading

This commit is contained in:
Debanjum Singh Solanky
2022-07-26 02:03:41 +04:00
parent 3728583e08
commit 674d933282

View File

@@ -1,7 +1,7 @@
[[https://github.com/debanjum/khoj/actions/workflows/test.yml/badge.svg]] [[https://github.com/debanjum/khoj/actions/workflows/build.yml/badge.svg]]
* Khoj
/Natural language search for your notes, transactions and images using transformer ML models/
/Natural language search engine for your personal notes, transactions and images using transformer ML models/
Interface with Khoj via [[./src/interface/web/index.html][Web]], [[./src/interface/emacs/khoj.el][Emacs]] or the [[http://localhost:8000/docs][API]]. All search is done locally[[https://github.com/debanjum/khoj#miscellaneous][*]]
@@ -41,12 +41,6 @@
- [[http://localhost:8000/regenerate?t=ledger][Regenerate Embeddings]]
- [[https://localhost:8000/ui][Configure Application]]
** Run Unit tests
#+begin_src shell
pytest
#+end_src
** Upgrade
#+begin_src shell
docker-compose build --pull
@@ -103,6 +97,11 @@
conda activate khoj
#+end_src
*** Run Unit tests
#+begin_src shell
pytest
#+end_src
** Acknowledgments
- [[https://huggingface.co/sentence-transformers/multi-qa-MiniLM-L6-cos-v1][Multi-QA MiniLM Model]] for Asymmetric Text Search. See [[https://www.sbert.net/examples/applications/retrieve_rerank/README.html][SBert Documentation]]
- [[https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2][All MiniLM Model]] for Symmetric Text Search