From f54f4148931122c62a7f6e4ffcacac26cfe47e15 Mon Sep 17 00:00:00 2001 From: Debanjum Singh Solanky Date: Mon, 1 Aug 2022 02:41:54 +0300 Subject: [PATCH 1/2] Move demo video to docs/ directory to keep project root clean --- demo.mp4 => docs/demo.mp4 | Bin 1 file changed, 0 insertions(+), 0 deletions(-) rename demo.mp4 => docs/demo.mp4 (100%) diff --git a/demo.mp4 b/docs/demo.mp4 similarity index 100% rename from demo.mp4 rename to docs/demo.mp4 From bcaf86f25a1925afc8c8fa47f6c7d14518cb7221 Mon Sep 17 00:00:00 2001 From: Debanjum Singh Solanky Date: Mon, 1 Aug 2022 02:42:48 +0300 Subject: [PATCH 2/2] Minor updates to Readme - Help test workflows not triggered on PR with changes to docs --- Readme.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Readme.md b/Readme.md index def61b4c..98f48979 100644 --- a/Readme.md +++ b/Readme.md @@ -17,7 +17,7 @@ - [Run](#Run) - [Use](#Use) - [Upgrade](#Upgrade) -- [Troubleshooting](#Troubleshooting) +- [Troubleshoot](#Troubleshoot) - [Miscellaneous](#Miscellaneous) - [Development Setup](#Development-setup) - [Setup on Local Machine](#Setup-on-local-machine) @@ -27,14 +27,14 @@ - [Query Performance](#Query-performance) - [Indexing Performance](#Indexing-performance) - [Miscellaneous](#Miscellaneous-1) -- [Acknowledgments](#Acknowledgments) +- [Credits](#Credits) ## Features - **Natural**: Advanced Natural language understanding using Transformer based ML Models - **Local**: Your personal data stays local. All search, indexing is done on your machine[\*](https://github.com/debanjum/khoj#miscellaneous) - **Incremental**: Incremental search for a fast, search-as-you-type experience -- **Pluggable**: Modular architecture makes it relatively easy to plug in new data sources, frontends and ML models +- **Pluggable**: Modular architecture makes it easy to plug in new data sources, frontends and ML models - **Multiple Sources**: Search your Org-mode and Markdown notes, Beancount transactions and Photos - **Multiple Interfaces**: Search using a [Web Browser](./src/interface/web/index.html), [Emacs](./src/interface/emacs/khoj.el) or the [API](http://localhost:8000/docs) @@ -99,7 +99,7 @@ docker-compose up -d docker-compose build --pull ``` -## Troubleshooting +## Troubleshoot - Symptom: Errors out with \"Killed\" in error message - Fix: Increase RAM available to Docker Containers in Docker Settings @@ -180,7 +180,7 @@ pytest - Testing done on a Mac M1 and a \>100K line corpus of notes - Search, indexing on a GPU has not been tested yet -## Acknowledgments +## Credits - [Multi-QA MiniLM Model](https://huggingface.co/sentence-transformers/multi-qa-MiniLM-L6-cos-v1), [All MiniLM Model](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2) for Text Search. See [SBert Documentation](https://www.sbert.net/examples/applications/retrieve_rerank/README.html) - [OpenAI CLIP Model](https://github.com/openai/CLIP) for Image Search. See [SBert Documentation](https://www.sbert.net/examples/applications/image-search/README.html)