Update README.md

README.md

@@ -10,13 +10,59 @@ tags:
 - llama
 - trl
 ---
+# This page is work in progress!
 
-# Uploaded  model
+## Overview
 
-- **Developed by:** Mubin1917
-- **License:** apache-2.0
-- **Finetuned from model :** unsloth/Phi-3.5-mini-instruct
+The **Fhi-3.5-mini-instruct** is a fine-tuned version of the [unsloth/Phi-3.5-mini-instruct](https://huggingface.co/unsloth/Phi-3.5-mini-instruct) model, optimized for function-calling capability. This model provides fast, accurate, and structured responses based on input queries and available APIs. It supports enhanced function-calling features on top of its existing Phi-3.5-mini-instruct's capabilities.
 
-This llama model was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth) and Huggingface's TRL library.
+### Usage
 
-[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
+Here’s a basic example of how to use function calling with the Fhi-3.5-mini-instruct model:
+
+```python
+def get_current_temperature(location: str) -> float:
+    """
+    Get the current temperature at a location.
+    
+    Args:
+        location: The location to get the temperature for, in the format "City, Country"
+    Returns:
+        The current temperature at the specified location in the specified units, as a float.
+    """
+    return 22.  
+
+# Create the messages list
+messages = [
+    {"role": "system", "content": "You are a helpful weather assistant."},
+    {"role": "user", "content": "What's the current weather in London and New York? Please use Celsius."}
+]
+
+# Apply the chat template
+prompt = tokenizer.apply_chat_template(
+    messages, 
+    tools=[get_current_temperature],  # Pass the custom tool
+    add_generation_prompt=True, 
+    tokenize=False
+)
+
+inputs = tokenizer([prompt], return_tensors="pt").to("cuda")
+outputs = model.generate(**inputs, max_new_tokens=512, do_sample=False, num_return_sequences=1, use_cache=True, temperature=0.001, top_p=1, eos_token_id=[32007])
+resu = tokenizer.decode(outputs[0][len(inputs[0]):], skip_special_tokens=True)
+print(resu)
+```
+
+The result will look like this:
+
+```python
+[
+    {'name': 'get_current_temperature', 'arguments': {'location': 'London, UK'}},
+    {'name': 'get_current_temperature', 'arguments': {'location': 'New York, USA'}}
+]
+```
+
+## Testing and Benchmarking
+This model is still undergoing testing and evaluation. Use it at your own risk until further validation is complete. Performance on benchmarks like MMLU and MMLU-Pro will be updated soon.
+
+## Credits
+Will be updated soon