Update tools/polite_guard.py

tools/polite_guard.py

@@ -2,9 +2,12 @@ from typing import Any, Optional
 from smolagents.tools import Tool
 from transformers import pipeline
 
-# Define the PoliteGuard tool
-# Classify text into politeness categories
+
 class PoliteGuardTool(Tool):
+    """Wrapper around a text tool that classifies text into politeness categories.
+    Args:
+        input_text: A string of English text.
+    """
     name = "polite_guard"
     description = "Calls an tool to classifify text by 4 labels from polite to impolite"
     inputs = {'input_text': {'type': 'any', 'description': 'Enter text for assessing whether it is respectful'}}
@@ -25,6 +28,11 @@ class PoliteGuardTool(Tool):
     
         Args:
             input_text: The text to classify.
+
+        Returns:
+            dictionary with
+                a. A in result['label'] which is one of the four classifications
+                b. A score in result['score']    
         """
         try:
             classifier = pipeline("text-classification", "Intel/polite-guard")