Updates to README.md
Browse files
README.md
CHANGED
@@ -3,8 +3,14 @@
|
|
3 |
## Model Details
|
4 |
Inkbot is a conversational AI model designed to interpret and respond to structured prompts with or without contextual information. Built on the latest advancements in natural language processing (NLP) and understanding (NLU), Inkbot provides users with accurate and meaningful interactions, addressing a wide range of queries and topics. Its unique feature lies in the structured prompt system, allowing users to engage in dynamic dialogues that can evolve based on context, metadata, and user input.
|
5 |
|
|
|
|
|
|
|
|
|
|
|
6 |
## How to Use
|
7 |
-
Inkbot uses a structured prompt template system.
|
|
|
8 |
|
9 |
### Prompt Template Structure
|
10 |
|
@@ -90,7 +96,7 @@ Dawn dispels the night.
|
|
90 |
|
91 |
## Task Options
|
92 |
|
93 |
-
Inkbot has been trained for a variety of tasks. Below are some of the key task options you can utilize:
|
94 |
|
95 |
1. **general**: This is the default task and is designed for a broad range of general questions and interactions.
|
96 |
|
@@ -120,18 +126,18 @@ Inkbot has been trained for a variety of tasks. Below are some of the key task o
|
|
120 |
|
121 |
- Usage: For tasks that require imaginative and original content generation.
|
122 |
|
123 |
-
### How to Use Task Options
|
124 |
-
|
125 |
-
In the prompt template structure, the `Task` metadata field is where you specify the task option. Here's an example of how to structure a prompt using the `reasoning` task:
|
126 |
-
|
127 |
|
128 |
## Limitations
|
129 |
-
-
|
130 |
- When providing contextual details, clarity is essential for Inkbot to derive accurate and meaningful responses.
|
|
|
|
|
|
|
131 |
|
132 |
## Additional Notes
|
133 |
- The 'date', 'task', and 'system' are crucial metadata components that need to be provided outside the core dialogue.
|
134 |
-
- Use the 'user_context'
|
|
|
135 |
|
136 |
|
137 |
---
|
|
|
3 |
## Model Details
|
4 |
Inkbot is a conversational AI model designed to interpret and respond to structured prompts with or without contextual information. Built on the latest advancements in natural language processing (NLP) and understanding (NLU), Inkbot provides users with accurate and meaningful interactions, addressing a wide range of queries and topics. Its unique feature lies in the structured prompt system, allowing users to engage in dynamic dialogues that can evolve based on context, metadata, and user input.
|
5 |
|
6 |
+
### Performance
|
7 |
+
- The model excels in RAG type queries, answering from context, and overriding memory when available.
|
8 |
+
- It can handle very large contexts, but may sometimes enter a repeating text loop, especially during complex tasks.
|
9 |
+
- The model is intended to be more functional and less chatty, avoiding the waste of tokens on superfluous language.
|
10 |
+
|
11 |
## How to Use
|
12 |
+
Inkbot uses a structured prompt template system.
|
13 |
+
|
14 |
|
15 |
### Prompt Template Structure
|
16 |
|
|
|
96 |
|
97 |
## Task Options
|
98 |
|
99 |
+
Inkbot has been trained for a variety of tasks. Below are some of the key task options you can utilize, but feel free to try others to test the effect:
|
100 |
|
101 |
1. **general**: This is the default task and is designed for a broad range of general questions and interactions.
|
102 |
|
|
|
126 |
|
127 |
- Usage: For tasks that require imaginative and original content generation.
|
128 |
|
|
|
|
|
|
|
|
|
129 |
|
130 |
## Limitations
|
131 |
+
- Adhere to the prompt structure for best results.
|
132 |
- When providing contextual details, clarity is essential for Inkbot to derive accurate and meaningful responses.
|
133 |
+
- The overriding memory from user_context property generally only works for the next prompt or two, after which the model reverts to its original behavior.
|
134 |
+
- On complex tasks, like creating a coherent story based on a set of facts from context, there's a potential for a repeating text loop as context fills.
|
135 |
+
- Sometimes the model doesn't know when to end a knowledge graph, which can result in adding nodes and edges until it runs out of context.
|
136 |
|
137 |
## Additional Notes
|
138 |
- The 'date', 'task', and 'system' are crucial metadata components that need to be provided outside the core dialogue.
|
139 |
+
- Use the 'user_context' when you want to offer supplementary context that guides Inkbot's response. You can interleave it in the chat log as necessary.
|
140 |
+
- The specific tag format, such as `<#word#>`, is used to because there are filters in a lot of APIs for <|word|> and this makes interactions easier.
|
141 |
|
142 |
|
143 |
---
|