Create README.md

README.md

@@ -0,0 +1,98 @@
+# Model Card for functionary-small-v2.2-GGUF
+
+[https://github.com/MeetKai/functionary](https://github.com/MeetKai/functionary)
+
+![Functionary Logo](https://huggingface.co/meetkai/functionary-medium-v2.2/resolve/main/functionary_logo.jpg "Functionary Logo")
+
+Functionary is a language model that can interpret and execute functions/plugins.
+
+The model determines when to execute functions, whether in parallel or serially, and can understand their outputs. It only triggers functions as needed. Function definitions are given as JSON Schema Objects, similar to OpenAI GPT function calls.
+
+## Key Features
+
+- Intelligent **parallel tool use**
+- Able to analyze functions/tools outputs and provide relevant responses **grounded in the outputs**
+- Able to decide **when to not use tools/call functions** and provide normal chat response
+- Truly one of the best open-source alternative to GPT-4
+
+## Performance
+
+Our model achieves achieves state-of-the-art performance in Function Calling Accuracy on our in-house dataset. The accuracy metric measures the overall correctness of predicted function calls, including function name prediction and arguments extraction.
+
+![Eval Chart](https://huggingface.co/meetkai/functionary-medium-v2.2/resolve/main/evaluation_chart.jpeg "Eval Chart")
+
+| Dataset       | Model Name          | Function Calling  Accuracy (Name & Arguments) |
+| :-------------| :-------------------| ---------------------------: | 
+| In-house data | MeetKai-functionary-small-v2.2  |                       0.546|
+| In-house data | MeetKai-functionary-medium-v2.2  |                       **0.664**|
+| In-house data | OpenAI-gpt-3.5-turbo-1106  |                        0.531 |
+| In-house data | OpenAI-gpt-4-1106-preview  |                        **0.737** |
+
+## Prompt Template
+
+We use a specially designed prompt template which we call "v2PromptTemplate" that breaks down each turns into from, recipient and content portions.
+
+We convert function definitions to a similar text to TypeScript definitions. Then we inject these definitions as system prompts. After that, we inject the default system prompt. Then we start the conversation messages.
+
+This formatting is also available via our vLLM server which we process the functions into Typescript definitions encapsulated in a system message and use a pre-defined Transformers chat template. This means that lists of messages can be formatted for you with the apply_chat_template() method within our server:
+
+```python
+from openai import OpenAI
+
+client = OpenAI(base_url="http://localhost:8000/v1", api_key="functionary")
+
+client.chat.completions.create(
+    model="path/to/functionary/model/",
+    messages=[{"role": "user",
+            "content": "What is the weather for Istanbul?"}
+    ],
+    tools=[{
+            "type": "function",
+            "function": {
+                "name": "get_current_weather",
+                "description": "Get the current weather",
+                "parameters": {
+                    "type": "object",
+                    "properties": {
+                        "location": {
+                            "type": "string",
+                            "description": "The city and state, e.g. San Francisco, CA"
+                        }
+                    },
+                    "required": ["location"]
+                }
+            }
+        }],
+    tool_choice="auto"
+)
+```
+
+will yield:
+
+```
+<|from|>system
+<|recipient|>all
+<|content|>// Supported function definitions that should be called when necessary.
+namespace functions {
+// Get the current weather
+type get_current_weather = (_: {
+// The city and state, e.g. San Francisco, CA
+location: string,
+}) => any;
+} // namespace functions
+<|from|>system
+<|recipient|>all
+<|content|>A chat between a curious user and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the user's questions. The assistant calls functions with appropriate input when necessary
+<|from|>user
+<|recipient|>all
+<|content|>What is the weather for Istanbul?
+```
+
+A more detailed example is provided [here](https://github.com/MeetKai/functionary/blob/main/tests/prompt_test_v2.txt).
+
+## Run the model
+
+We encourage users to run our models using our OpenAI-compatible vLLM server [here](https://github.com/MeetKai/functionary).
+
+# The MeetKai Team
+![MeetKai Logo](https://huggingface.co/meetkai/functionary-medium-v2.2/resolve/main/meetkai_logo.png "MeetKai Logo")