Files changed (1) hide show
  1. README.md +31 -0
README.md CHANGED
@@ -15,6 +15,37 @@ which effectively prevents the significant problem of language models forgetting
15
 
16
  We intend to be the first of a family of experimentations being carried out @ Cognitive Computations.
17
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
18
  # Quants
19
  - [dagbs/-GGUF](https://huggingface.co/dagbs/fc-dolphin-2.6-mistral-7b-dpo-laser-GGUF)
20
  - [solidrust/-AWQ](https://huggingface.co/solidrust/fc-dolphin-2.6-mistral-7b-dpo-laser-AWQ)
 
15
 
16
  We intend to be the first of a family of experimentations being carried out @ Cognitive Computations.
17
 
18
+ # Usage
19
+
20
+ This model is trained on a variaton of [glaive function calling v2](https://huggingface.co/datasets/glaiveai/glaive-function-calling-v2) and uses their format for declaring functions and invoking them.
21
+ Note that like other Dolphin models you should be using the ChatML syntax for representing chats.
22
+
23
+ Set your system prompt to something along these lines:
24
+
25
+ ```
26
+ You are a helpful assistant with access to the following functions.
27
+ Use them if required -
28
+ { "name": "search_wikipedia", "description": "Search for a given keyword or phrase on Wikipedia", "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "The keyword or phrase to search" } }, "required": [ "query" ] } }
29
+ ```
30
+
31
+ The model will then attempt to invoke the specified functions using the token `<functioncall>` and some JSON with a `name` and an `arguments` parameter.
32
+
33
+ e.g.:
34
+
35
+ ```
36
+ ASSISTANT: <functioncall> {"name": "search_wikipedia", "arguments": '{"query": "Eiffel Tower"}'} <|endoftext|>
37
+ ```
38
+
39
+ Your code should detect this and stop execution and invoke the function call and inject a response back into the context with the following syntax:
40
+
41
+ ```
42
+ FUNCTION RESPONSE: {"result": "The Eiffel Tower is a wrought-iron lattice... etc"}
43
+ ```
44
+
45
+ You should then prompt the assistant to generate another response.
46
+
47
+ Note that the model may not always attempt to invoke a function and may respond saying it doesn't have access to the right functionality.
48
+
49
  # Quants
50
  - [dagbs/-GGUF](https://huggingface.co/dagbs/fc-dolphin-2.6-mistral-7b-dpo-laser-GGUF)
51
  - [solidrust/-AWQ](https://huggingface.co/solidrust/fc-dolphin-2.6-mistral-7b-dpo-laser-AWQ)