mirror of
https://github.com/khoj-ai/khoj.git
synced 2024-11-23 15:38:55 +01:00
Spell fix s/e.g/e.g./ across code, tests and docs
This commit is contained in:
parent
8fc7f980aa
commit
732332a3c5
10 changed files with 18 additions and 17 deletions
|
@ -45,7 +45,8 @@ services:
|
|||
- KHOJ_DEBUG=False
|
||||
- KHOJ_ADMIN_EMAIL=username@example.com
|
||||
- KHOJ_ADMIN_PASSWORD=password
|
||||
# Uncomment the following lines to make your instance publicly accessible. Replace the domain with your domain. Proceed with caution, especially if you are using anonymous mode.
|
||||
# Uncomment the following lines to make your instance publicly accessible.
|
||||
# Replace the domain with your domain. Proceed with caution, especially if you are using anonymous mode.
|
||||
# - KHOJ_NO_HTTPS=True
|
||||
# - KHOJ_DOMAIN=192.168.0.104
|
||||
command: --host="0.0.0.0" --port=42110 -vv --anonymous-mode
|
||||
|
|
|
@ -90,13 +90,13 @@ M-x package-install khoj
|
|||
See [Khoj Search](/features/search) for details
|
||||
1. Hit `C-c s s` (or `M-x khoj RET s`) to open khoj search
|
||||
2. Enter your query in natural language<br/>
|
||||
E.g *"What is the meaning of life?"*, *"My life goals for 2023"*
|
||||
E.g. *"What is the meaning of life?"*, *"My life goals for 2023"*
|
||||
|
||||
### Chat
|
||||
See [Khoj Chat](/features/chat) for details
|
||||
1. Hit `C-c s c` (or `M-x khoj RET c`) to open khoj chat
|
||||
2. Ask questions in a natural, conversational style<br/>
|
||||
E.g *"When did I file my taxes last year?"*
|
||||
E.g. *"When did I file my taxes last year?"*
|
||||
|
||||
### Find Similar Entries
|
||||
This feature finds entries similar to the one you are currently on.
|
||||
|
@ -105,7 +105,7 @@ This feature finds entries similar to the one you are currently on.
|
|||
|
||||
### Advanced Usage
|
||||
- Add [query filters](https://github.com/khoj-ai/khoj/#query-filters) during search to narrow down results further
|
||||
e.g `What is the meaning of life? -"god" +"none" dt>"last week"`
|
||||
e.g. `What is the meaning of life? -"god" +"none" dt>"last week"`
|
||||
|
||||
- Use `C-c C-o 2` to open the current result at cursor in its source org file
|
||||
- This calls `M-x org-open-at-point` on the current entry and opens the second link in the entry.
|
||||
|
|
|
@ -31,7 +31,7 @@ See the official [Obsidian Plugin Docs](https://help.obsidian.md/Extending+Obsid
|
|||
## Use
|
||||
### Chat
|
||||
Click the *Khoj chat* icon 💬 on the [Ribbon](https://help.obsidian.md/User+interface/Workspace/Ribbon) or run *Khoj: Chat* from the [Command Palette](https://help.obsidian.md/Plugins/Command+palette) and ask questions in a natural, conversational style.<br />
|
||||
E.g *"When did I file my taxes last year?"*
|
||||
E.g. *"When did I file my taxes last year?"*
|
||||
|
||||
See [Khoj Chat](/features/chat) for more details
|
||||
|
||||
|
|
|
@ -10,7 +10,7 @@ Here are some top-level performance metrics for Khoj. These are rough estimates
|
|||
|
||||
- Semantic search using the bi-encoder is fairly fast at \<100 ms across all content types
|
||||
- Reranking using the cross-encoder is slower at \<2s on 15 results. Tweak `top_k` to tradeoff speed for accuracy of results
|
||||
- Filters in query (e.g by file, word or date) usually add \<20ms to query latency
|
||||
- Filters in query (e.g. by file, word or date) usually add \<20ms to query latency
|
||||
|
||||
### Indexing performance
|
||||
|
||||
|
|
|
@ -354,7 +354,7 @@ export function getLinkToEntry(sourceFiles: TFile[], chosenFile: string, chosenE
|
|||
// This finds longest path match when multiple files have same name
|
||||
.sort((a, b) => b.path.length - a.path.length)
|
||||
// The first match is the best file match across OS
|
||||
// e.g Khoj server on Linux, Obsidian vault on Android
|
||||
// e.g. Khoj server on Linux, Obsidian vault on Android
|
||||
.find(file => chosenFile.replace(/\\/g, "/").endsWith(file.path))
|
||||
|
||||
// Return link to vault file at heading of chosen search result
|
||||
|
|
|
@ -213,7 +213,7 @@ class SearchModelConfig(BaseModel):
|
|||
model_type = models.CharField(max_length=200, choices=ModelType.choices, default=ModelType.TEXT)
|
||||
# Bi-encoder model of sentence-transformer type to load from HuggingFace
|
||||
bi_encoder = models.CharField(max_length=200, default="thenlper/gte-small")
|
||||
# Config passed to the sentence-transformer model constructor. E.g device="cuda:0", trust_remote_server=True etc.
|
||||
# Config passed to the sentence-transformer model constructor. E.g. device="cuda:0", trust_remote_server=True etc.
|
||||
bi_encoder_model_config = models.JSONField(default=dict)
|
||||
# Query encode configs like prompt, precision, normalize_embeddings, etc. for sentence-transformer models
|
||||
bi_encoder_query_encode_config = models.JSONField(default=dict)
|
||||
|
|
|
@ -125,7 +125,7 @@ class DateFilter(BaseFilter):
|
|||
return []
|
||||
|
||||
# extract, parse natural dates ranges from date range filter passed in query
|
||||
# e.g today maps to (start_of_day, start_of_tomorrow)
|
||||
# e.g. today maps to (start_of_day, start_of_tomorrow)
|
||||
date_ranges_from_filter = []
|
||||
for cmp, date_str in date_range_matches:
|
||||
if self.parse(date_str):
|
||||
|
@ -133,7 +133,7 @@ class DateFilter(BaseFilter):
|
|||
date_ranges_from_filter += [[cmp, (dt_start.timestamp(), dt_end.timestamp())]]
|
||||
|
||||
# Combine dates with their comparators to form date range intervals
|
||||
# For e.g
|
||||
# For e.g.
|
||||
# >=yesterday maps to [start_of_yesterday, inf)
|
||||
# <tomorrow maps to [0, start_of_tomorrow)
|
||||
# ---
|
||||
|
|
|
@ -268,7 +268,7 @@ def log_telemetry(
|
|||
# API endpoint on server called by client
|
||||
request_body["api"] = api
|
||||
if client:
|
||||
# Client from which the API was called. E.g Emacs, Obsidian
|
||||
# Client from which the API was called. E.g. Emacs, Obsidian
|
||||
request_body["client"] = client
|
||||
|
||||
# Log telemetry data to telemetry endpoint
|
||||
|
|
|
@ -445,7 +445,7 @@ def get_sample_data(type):
|
|||
|
||||
** Installation
|
||||
*** Direct
|
||||
- Put ~khoj.el~ in your Emacs load path. For e.g ~/.emacs.d/lisp
|
||||
- Put ~khoj.el~ in your Emacs load path. For e.g. ~/.emacs.d/lisp
|
||||
- Load via ~use-package~ in your ~/.emacs.d/init.el or .emacs file by adding below snippet
|
||||
#+begin_src elisp
|
||||
;; Khoj Package
|
||||
|
@ -467,12 +467,12 @@ def get_sample_data(type):
|
|||
** Usage
|
||||
1. Call ~khoj~ using keybinding ~C-c s~ or ~M-x khoj~
|
||||
2. Enter Query in Natural Language
|
||||
e.g "What is the meaning of life?" "What are my life goals?"
|
||||
e.g. "What is the meaning of life?" "What are my life goals?"
|
||||
3. Wait for results
|
||||
*Note: It takes about 15s on a Mac M1 and a ~100K lines corpus of org-mode files*
|
||||
4. (Optional) Narrow down results further
|
||||
Include/Exclude specific words from results by adding to query
|
||||
e.g "What is the meaning of life? -god +none"
|
||||
e.g. "What is the meaning of life? -god +none"
|
||||
|
||||
""",
|
||||
"readme.org": """
|
||||
|
|
6
tests/data/org/interface_emacs_readme.org
vendored
6
tests/data/org/interface_emacs_readme.org
vendored
|
@ -6,7 +6,7 @@
|
|||
|
||||
** Install
|
||||
*** Direct
|
||||
- Put ~khoj.el~ in your Emacs load path. For e.g ~/.emacs.d/lisp
|
||||
- Put ~khoj.el~ in your Emacs load path. For e.g. ~/.emacs.d/lisp
|
||||
- Load via ~use-package~ in your ~/.emacs.d/init.el or .emacs file by adding below snippet
|
||||
#+begin_src elisp
|
||||
;; Khoj Package
|
||||
|
@ -28,9 +28,9 @@
|
|||
** Usage
|
||||
1. Call ~khoj~ using keybinding ~C-c s~ or ~M-x khoj~
|
||||
2. Enter Query in Natural Language
|
||||
e.g "What is the meaning of life?" "What are my life goals?"
|
||||
e.g. "What is the meaning of life?" "What are my life goals?"
|
||||
3. Wait for results
|
||||
*Note: It takes about 15s on a Mac M1 and a ~100K lines corpus of org-mode files*
|
||||
4. (Optional) Narrow down results further
|
||||
Include/Exclude specific words from results by adding to query
|
||||
e.g "What is the meaning of life? -god +none"
|
||||
e.g. "What is the meaning of life? -god +none"
|
||||
|
|
Loading…
Reference in a new issue