From 7cd35082b27f5cf601341ac82a25327c98c4186b Mon Sep 17 00:00:00 2001
From: Petr Mironychev <9195189+Palm1r@users.noreply.github.com>
Date: Tue, 10 Sep 2024 14:37:33 +0200
Subject: [PATCH] Add using custom template to README.md
---
README.md | 23 +++++++++++++++++++++--
1 file changed, 21 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index dfec126..a0168c4 100644
--- a/README.md
+++ b/README.md
@@ -13,12 +13,31 @@ QodeAssist currently supports the following LLM (Large Language Model) providers
## Supported Models
-QodeAssist has been tested with the following language models, all trained for Fill-in-the-Middle:
+QodeAssist has been thoroughly tested and optimized for use with the following language models, all of which are specifically trained for Fill-in-the-Middle (FIM) tasks:
-- CodeLlama
+- CodeLlama
- StarCoder2
- DeepSeek-Coder-V2-Lite-Base
+These models have demonstrated excellent performance in code completion and assistance tasks within the QodeAssist environment.
+
+### Custom Prompts
+
+For advanced users or those with specific requirements, QodeAssist offers the flexibility to create, save, and load custom prompts using JSON templates. This feature allows you to tailor the AI's behavior to your exact needs.
+
+To get started with custom prompts:
+
+1. Navigate to the "Custom Template" option in the FIM Prompt Settings.
+2. Create your custom JSON prompt template.
+3. Use the "Save Custom Template to JSON" button to store your template for future use.
+4. To use a previously saved template, click "Load Custom Template from JSON".
+5. Make sure to select "Custom Template" from the dropdown menu in the FIM Prompt Settings on the General page to activate your custom template.
+
+For inspiration and examples of effective custom prompts, please refer to the `rawPromptExamples` folder in our repository.
+
+
+
+
### Tested Models
#### Ollama: