Update README.md

README.md

@@ -110,7 +110,7 @@ def get_probablities(logprobs):
 
     return probabilities
 
-model_path = "granite-guardian-3.1-2b"
+model_path = "ibm-granite/granite-guardian-3.1-2b"
 
 model = AutoModelForCausalLM.from_pretrained(
     model_path,
@@ -186,7 +186,66 @@ with torch.no_grad():
 
 label, prob_of_risk = parse_output(output, input_len)
 print(f"# risk detected? : {label}") # Yes
-print(f"# probability of risk: {prob_of_risk:.3f}") # 0.996
+print(f"# probability of risk: {prob_of_risk:.3f}") # 0.997
+
+# Usage 3: Example for hallucination risk in function call (risk_name=function_call passed through guardian_config)
+
+tools = [
+  {
+    "name": "comment_list",
+    "description": "Fetches a list of comments for a specified IBM video using the given API.",
+    "parameters": {
+      "aweme_id": {
+        "description": "The ID of the IBM video.",
+        "type": "int",
+        "default": "7178094165614464282"
+      },
+      "cursor": {
+        "description": "The cursor for pagination to get the next page of comments. Defaults to 0.",
+        "type": "int, optional",
+        "default": "0"
+      },
+      "count": {
+        "description": "The number of comments to fetch. Maximum is 30. Defaults to 20.",
+        "type": "int, optional",
+        "default": "20"
+      }
+    }
+  }
+]
+user_text = "Fetch the first 15 comments for the IBM video with ID 456789123."
+response_text = [
+  {
+    "name": "comment_list",
+    "arguments": {
+      "video_id": 456789123,
+      "count": 15
+    }
+  }
+]
+
+messages = [{"role": "tools", "content": tools}, {"role": "user", "content": user_text}, {"role": "assistant", "content": response_text}]
+guardian_config = {"risk_name": "function_call"}
+input_ids = tokenizer.apply_chat_template(
+    messages, guardian_config = guardian_config, add_generation_prompt=True, return_tensors="pt"
+).to(model.device)
+input_len = input_ids.shape[1]
+
+model.eval()
+
+with torch.no_grad():
+    output = model.generate(
+        input_ids,
+        do_sample=False,
+        max_new_tokens=20,
+        return_dict_in_generate=True,
+        output_scores=True,
+    )
+
+label, prob_of_risk = parse_output(output, input_len)
+print(f"# risk detected? : {label}") # Yes
+print(f"# probability of risk: {prob_of_risk:.3f}") # 0.679
+
 ```
 
 ### Prompt Template