Upload model via Google Colab

.gitattributes

@@ -33,3 +33,13 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+hammer2.1-3b-Q2_K.gguf filter=lfs diff=lfs merge=lfs -text
+hammer2.1-3b-Q2_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+hammer2.1-3b-Q3_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+hammer2.1-3b-Q4_0.gguf filter=lfs diff=lfs merge=lfs -text
+hammer2.1-3b-Q4_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+hammer2.1-3b-Q5_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+hammer2.1-3b-Q6_K.gguf filter=lfs diff=lfs merge=lfs -text
+hammer2.1-3b-Q8_0.gguf filter=lfs diff=lfs merge=lfs -text
+hammer2.1-3b-f16.gguf filter=lfs diff=lfs merge=lfs -text
+imatrix.dat filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,239 @@
+---
+license: other
+license_name: qwen-research
+license_link: https://huggingface.co/MadeAgents/Hammer2.1-3b/blob/main/LICENSE
+datasets:
+- Salesforce/xlam-function-calling-60k
+- MadeAgents/xlam-irrelevance-7.5k
+base_model:
+- Qwen/Qwen2.5-Coder-3B-Instruct
+---
+# Hammer2.1-3b Function Calling Model
+
+## Introduction
+
+Hammer refers to a series of lightweight Large Action Models. Currently, we are releasing Hammer 2.1 models ([0.5B](https://huggingface.co/MadeAgents/Hammer2.1-0.5b), [1.5B](https://huggingface.co/MadeAgents/Hammer2.1-1.5b), [3B](https://huggingface.co/MadeAgents/Hammer2.1-3b), and [7B](https://huggingface.co/MadeAgents/Hammer2.1-7b)) with strong function calling capability. These models are based on the Qwen 2.5 coder series and utilize [function masking techniques](https://arxiv.org/abs/2410.04587) and other advanced technologies. Hammer 2.1 series bring significant enhancements, while still maintaining the basic functionality of Hammer 2.0's Single-Turn interaction and further strengthening other capabilities.
+
+## Model Details
+The Hammer 2.1 models, fine-tuned from the Qwen 2.5 coder series, inherit Hammer 2.0's advantages and are enhanced as follows:
+- <span style="color: red;">Multi-Step Function Calling:</span> The assistant can perform multiple internal function calls to handle a single user request, actively planning and gathering information to fulfill complex tasks.
+- <span style="color: red;">Multi-Turn Function Calling:</span> Enables continuous and context-aware interactions over multiple exchanges, with each turn potentially containing multiple steps, for a more natural conversation experience.
+- Enhanced Irrelevant Information Inspection: Better at identifying when provided functions are irrelevant to a user query, by providing a non-function call response.
+
+## Evaluation
+The evaluation results of Hammer 2.1 models on the Berkeley Function-Calling Leaderboard (BFCL-v3) are presented in the following table:
+<div style="text-align: center;">
+    <img src="v2_figures/bfcl.png" alt="overview" width="1000" style="margin: auto;">
+</div>
+
+Our Hammer 2.1 series consistently achieves corresponding best performance at comparable scales. The 7B/3B/1.5B model outperform most function calling enchanced models.
+
+In addition, we evaluated the Hammer 2.1 models on other academic benchmarks to further demonstrate the generalization ability of our models.
+
+<div style="text-align: center;">
+    <img src="v2_figures/others-v2.png" alt="overview" width="1000" style="margin: auto;">
+</div>
+
+Hammer 2.1 models showcase highly stable performance, suggesting the robustness of Hammer 2.1 series. In contrast, the baseline approaches display varying levels of effectiveness.
+
+
+
+## Requiements
+The code of Hammer 2.1 models have been in the latest Hugging face transformers and we advise you to install `transformers>=4.47.0`.
+
+## How to Use
+Hammer models offer flexibility in deployment and usage, fully supporting both **vLLM** deployment and **Hugging Face Transformers** tool calling. Below are the specifics on how to make use of these features:
+
+### Using vLLM
+#### Option 1: Using Hammer client (Recommended)
+
+Before using vLLM, first clone the Hammer code repository and change directory to the 'Hammer':
+```
+git clone https://github.com/MadeAgents/Hammer.git
+cd Hammer
+```
+
+vLLM offers efficient serving with lower latency. To serve the model with vLLM:
+```
+vllm serve MadeAgents/Hammer2.1-3b --host 0.0.0.0 --port 8000 --tensor-parallel-size 1
+```
+Once the model is served, you can use the following Hammer client to interact with it for function calling:
+~~~
+from client import HammerChatCompletion,HammerConfig
+config = HammerConfig(base_url="http://localhost:8000/v1/", model="MadeAgents/Hammer2.1-3b")
+llm = HammerChatCompletion.from_config(config)
+
+# Example conversation
+messages = [
+    {"role": "user", "content": "What's the weather like in New York?"},
+    {"role": "assistant","content": '```\n{"name": "get_weather", "arguments": {"location": "New York, NY ", "unit": "celsius"}\n```'},
+    {"role": "tool", "name": "get_weather", "content": '{"temperature": 72, "description": "Partly cloudy"}'},
+    {"role": "user", "content": "Now, search for the weather in San Francisco."}
+]
+
+# Example function definition (optional)
+tools = [
+    {
+        "name": "get_weather",
+        "description": "Get the current weather for a location",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "location": {"type": "string", "description": "The city and state, e.g. San Francisco, CA"},
+                "unit": {"type": "string", "enum": ["celsius", "fahrenheit"], "description": "The unit of temperature to return"}
+            },
+            "required": ["location"]
+        }
+    },
+    {
+        "name": "respond",
+        "description": "When you are ready to respond, use this function. This function allows the assistant to formulate and deliver appropriate replies based on the input message and the context of the conversation. Generate a concise response for simple questions, and a more detailed response for complex questions.",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "message": {"type": "string", "description": "The content of the message to respond to."}
+            },
+            "required": ["message"]
+        }
+    }
+]
+
+response = llm.completion(messages, tools=tools)
+print(response)
+~~~
+
+
+#### Option 2: Using vLLM’s built-in tool calling
+Hammer2.1 supports vllm’s built-in tool calling. This functionality requires vllm>=0.6. If you want to enable this functionality, please start vllm’s OpenAI-compatible service with:
+~~~
+vllm serve MadeAgents/Hammer2.1-3b --enable-auto-tool-choice --tool-call-parser hermes
+~~~
+And then use it in the same way you use GPT’s tool calling:
+~~~
+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",
+                    },
+                    "format": {
+                        "type": "string",
+                        "enum": ["celsius", "fahrenheit"],
+                        "description": "The temperature unit to use. Infer this from the users location.",
+                        "default": "celsius"
+                    },
+                },
+                "required": ["location","format"],
+            },
+        }
+    },
+    {
+        "type": "function",
+        "function": {
+            "name": "get_n_day_weather_forecast",
+            "description": "Get an N-day weather forecast",
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    "location": {
+                        "type": "string",
+                        "description": "The city and state, e.g. San Francisco, CA",
+                    },
+                    "format": {
+                        "type": "string",
+                        "enum": ["celsius", "fahrenheit"],
+                        "description": "The temperature unit to use. Infer this from the users location.",
+                        "default": "celsius"
+                    },
+                    "num_days": {
+                        "type": "integer",
+                        "description": "The number of days to forecast",
+                        "default": 1
+                    }
+                },
+                "required": ["location", "format", "num_days"]
+            },
+        }
+    },
+]
+
+
+from openai import OpenAI
+openai_api_key = "None"
+openai_api_base = "http://localhost:8000/v1"
+
+client = OpenAI(
+    api_key=openai_api_key,
+    base_url=openai_api_base,
+)
+
+query = """What's the weather like today in San Francisco"""
+
+chat_response = client.chat.completions.create(
+    model="MadeAgents/Hammer2.1-3b",
+    messages=[
+        {"role": "user", "content": query},],
+    tools = tools,
+    temperature=0
+)
+print(chat_response.choices[0].message.content)
+~~~
+
+
+### Using Hugging Face Transformers
+Hammer2.1’s chat template also includes a tool calling template, meaning that you can use Hugging Face transformers’ tool calling support. This is a simple example of how to use our model using Transformers.
+~~~
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+
+tokenizer = AutoTokenizer.from_pretrained("MadeAgents/Hammer2.1-3b")
+model = AutoModelForCausalLM.from_pretrained("MadeAgents/Hammer2.1-3b", torch_dtype=torch.bfloat16, device_map="auto")
+
+# Example conversation
+messages = [
+    {"role": "user", "content": "What's the weather like in New York?"},
+    {"role": "assistant","content": '```\n{"name": "get_weather", "arguments": {"location": "New York, NY ", "unit": "celsius"}\n```'},
+    {"role": "tool", "name": "get_weather", "content": '{"temperature": 72, "description": "Partly cloudy"}'},
+    {"role": "user", "content": "Now, search for the weather in San Francisco."}
+]
+
+# Example function definition (optional)
+tools = [
+    {
+        "name": "get_weather",
+        "description": "Get the current weather for a location",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "location": {"type": "string", "description": "The city and state, e.g. San Francisco, CA"},
+                "unit": {"type": "string", "enum": ["celsius", "fahrenheit"], "description": "The unit of temperature to return"}
+            },
+            "required": ["location"]
+        }
+    },
+    {
+        "name": "respond",
+        "description": "When you are ready to respond, use this function. This function allows the assistant to formulate and deliver appropriate replies based on the input message and the context of the conversation. Generate a concise response for simple questions, and a more detailed response for complex questions.",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "message": {"type": "string", "description": "The content of the message to respond to."}
+            },
+            "required": ["message"]
+        }
+    }
+]
+
+inputs = tokenizer.apply_chat_template(messages, tools=tools, add_generation_prompt=True, return_dict=True, return_tensors="pt")
+inputs = {k: v.to(model.device) for k, v in inputs.items()}
+out = model.generate(**inputs, max_new_tokens=128)
+print(tokenizer.decode(out[0][len(inputs["input_ids"][0]):], skip_special_tokens=True))
+~~~

hammer2.1-3b-Q2_K.gguf

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2fa787cdc1d314dc73b35f6e882d045b76062d67e7e67b02121d2dac7cece218
+size 1274295104

hammer2.1-3b-Q2_K_S.gguf

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:33138ca1b75be48c03284340ae0a0074758163a5e815008c5ccc583293e9dbee
+size 1197667136

hammer2.1-3b-Q3_K_M.gguf

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:52408af9d7d881e8bf71b881844debfe23b408d21bc8ccebbc98829680ba1eca
+size 1590014784

hammer2.1-3b-Q4_0.gguf

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:667723a1d374501974fbedde1ccc7014c6498aee75fc5abddc59820bc2fd4f60
+size 1828025152

hammer2.1-3b-Q4_K_M.gguf

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a42369a669dbab0be10f1e04d755e55eb103b4b1bb7b4dec8c0ce4cf6c12b98d
+size 1929442112

hammer2.1-3b-Q5_K_M.gguf

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:bac437adc93b1996be5140e5946dc7fbae5d3ef9eced124a0d830d9e0e7a1562
+size 2224354112

hammer2.1-3b-Q6_K.gguf

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8d5485e395b24bd25092f5ea5934a9af3a61cf1970635a79afbf9a7eeeb9e243
+size 2537698112

hammer2.1-3b-Q8_0.gguf

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7367edbec88feb5587b0e5f17e5f356c62a7c440e7f199f84c9c48f957addac5
+size 3284880928

hammer2.1-3b-f16.gguf

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:28eefc018864f9fbd01e635d5dad523e30c4de19ffce96a62de7a51d129bc11a
+size 6177201280

imatrix.dat

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a4232c085249d7ada5f761d58fa92ce05e865a4124bfbad89c7593ba1ffa0de0
+size 3363009