Update README.md

README.md

@@ -10,9 +10,6 @@ library_name: transformers
 
 # StarfleetAI Polaris Small
 
-> [!NOTE]  
-> Work on the model card is still in progress.
-
 > [!WARNING]  
 > Even though the model is not yet meant for production usage, we still encourage you to give it a try and tell us what you think.
 >
@@ -26,14 +23,73 @@ This model was developed by StarfleetAI with the aim of it being used for autono
 * Additionally trained on coding tasks
 * Trained for function calling
 
-## Features
+## Current Features
+
+As of version `0.1` the model is:
+
+- Able to call a functions
+- Not bad at coding tasks
+
+## Work To Do
+
+- Needs more training on examples where function call should be performed in the middle/end parts of the conversation, rather than in the beginning
+- Needs to eliminate some hallucinations (it, for example, sometimes regressing news articles instead of calling the `get_rss_feed` function, and stuff like that)
+- Correct typography (`Answer: 123` instead of `Answer:123`)
+- Current date / time / timezone conversational abilities ("Schedule a call tomorrow at 6PM")
+- Needs some DPO
+- Need to be evaluated on relevant metrics
+
+## Prompt Format
+
+We wanted our prompt to:
+
+1. Have a configurable `system` prompt part, which is meant to be changed by the end user.
+2. Describe the functions available to the model (in a specific, static place in the prompt, making it easier for the model to identify them).
+3. Be capable of carrying additional configuration options in the future, such as the current date/time or the user's name.
+
+In order to fullfill these needs, we designed the prompt format, which seems to tick all the boxes.
+
+### With Functions
+
+```
+## Configuration
+
+Functions: enabled
+
+## Available Functions
+
+{ ... }
+{ ... }
+
+---
+
+You are a helpful assistant.
+```
+
+### Without Functions
+
+```
+## Configuration
+
+Functions: disabled
+
+---
+
+You are a helpful assistant.
+```
+
+## Functions Calling
+
+In order for the model to call a function, we have introduced two new tokens: `<|fn_start|>` and `<|fn_end|>`. It's safe to assume that if the model decides to call a function, there will be no other response from it except for the function call between these special tokens. If this is not true for some of your cases, please feel free to contact us with examples.
+
+For now, the model is only capable of calling one function at a time.
+
+### Example Function Call
+
+```
+<|fn_start|>{"name": "generate_password", "arguments": {"length": 42}}<|fn_end|>
+```
 
-- [x] Function calling
-  - [ ] Needs more training on examples where function call should be performed in the middle/end parts of the conversation, rather than in the beginning
-- [ ] Needs to eliminate some hallucinations (it, for example, sometimes regressing news articles instead of calling the `get_rss_feed` function, and stuff like that)
-- [ ] Correct typography (currently: `Answer:123` instead of `Answer: 123`)
-- [ ] Current date / time / timezone conversational abilities
-- [ ] Needs some DPO
 
 ### Model Description