khoj/sample_config.yml

content-type:
  org:
    input-files: ["src/tests/data/main_readme.org", "src/tests/data/interface_emacs_readme.org"]
    input-filter: null
    compressed-jsonl: ".notes.json.gz"
    embeddings-file: ".note_embeddings.pt"

  ledger:
    compressed-jsonl: ".transactions.jsonl.gz"
    embeddings-file: ".transaction_embeddings.pt"

  image:
    embeddings-file: '.image_embeddings.pt'
    batch-size: 50
    use-xmp-metadata: 'no'

search-type:
  asymmetric:
    encoder: "sentence-transformers/msmarco-MiniLM-L-6-v3"
    cross-encoder: "cross-encoder/ms-marco-MiniLM-L-6-v2"

  image:
    encoder: "clip-ViT-B-32"
Use YAML file to allow user to configure application. Add tests - YAML Config - Can specify all params[1] earlier being passed via cmd args in config YAML - Can now also configure sentence-transformer models to use etc for search - [1] Config params - org files - compressed entries file config path - embeddings file config path - Include sample_config.yaml - Include sample .org file from this repos readmes - CLI - Configuration Priority: Config via cmd > Config via YAML > Default Config - Test CLI, include test config.yml for the tests - Set default type to None unless set via query param to API Run notes search if search_enabled, also if type is None (default) Prepares for running queries on all search types unless type specified in API query param - Update Readme 2021-08-22 03:47:55 +02:00			`content-type:`
			`org:`
			`input-files: ["src/tests/data/main_readme.org", "src/tests/data/interface_emacs_readme.org"]`
			`input-filter: null`
			`compressed-jsonl: ".notes.json.gz"`
			`embeddings-file: ".note_embeddings.pt"`

Update sample config to add minimal config for ledger, image search 2021-08-23 06:54:49 +02:00			`ledger:`
			`compressed-jsonl: ".transactions.jsonl.gz"`
			`embeddings-file: ".transaction_embeddings.pt"`

			`image:`
			`embeddings-file: '.image_embeddings.pt'`
Make image batch size to encode configurable via config.yml 2021-09-16 19:51:39 +02:00			`batch-size: 50`
Make Using XMP Metadata to Enhance Image Search Optional, Configurable - Break the compute embeddings method into separate methods: compute_image_embeddings and compute_metadata_embeddings - If image_metadata_embeddings isn't defined, do not use it to enhance search results. Given image_metadata_embeddings wouldn't be defined if use_xmp_metadata is False, we can avoid unnecessary addition of args to query method 2021-09-16 21:01:05 +02:00			`use-xmp-metadata: 'no'`
Update sample config to add minimal config for ledger, image search 2021-08-23 06:54:49 +02:00
Use YAML file to allow user to configure application. Add tests - YAML Config - Can specify all params[1] earlier being passed via cmd args in config YAML - Can now also configure sentence-transformer models to use etc for search - [1] Config params - org files - compressed entries file config path - embeddings file config path - Include sample_config.yaml - Include sample .org file from this repos readmes - CLI - Configuration Priority: Config via cmd > Config via YAML > Default Config - Test CLI, include test config.yml for the tests - Set default type to None unless set via query param to API Run notes search if search_enabled, also if type is None (default) Prepares for running queries on all search types unless type specified in API query param - Update Readme 2021-08-22 03:47:55 +02:00			`search-type:`
			`asymmetric:`
			`encoder: "sentence-transformers/msmarco-MiniLM-L-6-v3"`
			`cross-encoder: "cross-encoder/ms-marco-MiniLM-L-6-v2"`
Update sample config to add minimal config for ledger, image search 2021-08-23 06:54:49 +02:00
			`image:`
			`encoder: "clip-ViT-B-32"`