Update README.md
Browse files
README.md
CHANGED
|
@@ -80,9 +80,15 @@ An example extraction and RAG-Agent can be found here: [Link](example/vllm_v2_ex
|
|
| 80 |
1. When giving docstrings to Athene-V2-Agent, please provide well-indented, detailed, and well-written docstrings as this can help accuracy.
|
| 81 |
2. We strongly recommend using the docker image to interact with Athene-V2-Agent.
|
| 82 |
4. We strongly recommend to set sampling to False when prompting Athene-V2-Agent.
|
| 83 |
-
5. We strongly recommend a zero temperature.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 84 |
|
| 85 |
-
When handling irrelevant user queries, users have noticed that specifying a "no-op" function with arguments work best. For example, something like this might work:
|
| 86 |
```python
|
| 87 |
{
|
| 88 |
"type": "function",
|
|
@@ -102,6 +108,39 @@ When handling irrelevant user queries, users have noticed that specifying a "no-
|
|
| 102 |
}
|
| 103 |
}
|
| 104 |
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 105 |
|
| 106 |
## Contact
|
| 107 |
Please join our [Discord Channel](https://discord.gg/HDSVmNAs3y) to reach out for any issues and comments!
|
|
|
|
| 80 |
1. When giving docstrings to Athene-V2-Agent, please provide well-indented, detailed, and well-written docstrings as this can help accuracy.
|
| 81 |
2. We strongly recommend using the docker image to interact with Athene-V2-Agent.
|
| 82 |
4. We strongly recommend to set sampling to False when prompting Athene-V2-Agent.
|
| 83 |
+
5. We strongly recommend a zero temperature.
|
| 84 |
+
6. Athene-V2-Agent is designed to work within systems, so it's tuned to be very controllable with the instructions specified in the tools, including for broad behaviors (like rejecting queries, or chatting)
|
| 85 |
+
|
| 86 |
+
#### Handling Irrelevant Queries
|
| 87 |
+
The Athene-V2-Agent model is strongly tuned to have its behavior be controllable with tools to make it easy to integrate into systems.
|
| 88 |
+
|
| 89 |
+
Therefore, the model won't by default reject queries that are out of domain, as it will try its best to issue the most relevant call.
|
| 90 |
+
However, when expecting irrelevant user queries and wanting the model to reject them, you can use a no-op function. For example, something like this would work:
|
| 91 |
|
|
|
|
| 92 |
```python
|
| 93 |
{
|
| 94 |
"type": "function",
|
|
|
|
| 108 |
}
|
| 109 |
}
|
| 110 |
```
|
| 111 |
+
Please see the example [Link](example/vllm_v2_weather_agent.py) here for a demo of this.
|
| 112 |
+
|
| 113 |
+
#### Handling Chat With FC
|
| 114 |
+
|
| 115 |
+
Since Athene-V2-Agent model is strongly tuned to be controllable, so we wanted to ensure that it does not chat unless explicitly instructed to do so.
|
| 116 |
+
You can do this by adding a `chat` tool, and allowing it to do so in the system prompt:
|
| 117 |
+
|
| 118 |
+
```python
|
| 119 |
+
{
|
| 120 |
+
"type": "function",
|
| 121 |
+
"function": {
|
| 122 |
+
"name": "chat",
|
| 123 |
+
"description": "Call this tool when you want to chat with the user. The user won't see anything except for whatever you pass into this function.",
|
| 124 |
+
"parameters": {
|
| 125 |
+
"type": "object",
|
| 126 |
+
"properties": {
|
| 127 |
+
"chat_string": {
|
| 128 |
+
"type": "string",
|
| 129 |
+
"description": "The string to send to the user to chat back to them.",
|
| 130 |
+
}
|
| 131 |
+
},
|
| 132 |
+
"required": ["chat_string"],
|
| 133 |
+
},
|
| 134 |
+
},
|
| 135 |
+
}
|
| 136 |
+
```
|
| 137 |
+
|
| 138 |
+
And the following system prompt, as an example (but feel free to experiment to make Athene-V2-Agent behave the way you want it to!):
|
| 139 |
+
```python
|
| 140 |
+
{"role" : "system", "content" : "Make sure to use the chat function to provide the final answer to the user."},
|
| 141 |
+
```
|
| 142 |
+
|
| 143 |
+
Please see the example [Link](example/weather_with_chat.py) here for a demo of this.
|
| 144 |
|
| 145 |
## Contact
|
| 146 |
Please join our [Discord Channel](https://discord.gg/HDSVmNAs3y) to reach out for any issues and comments!
|