📝 Add comments describing usage of decorator

Signed-off-by: Gaurav-Kumbhat <Gaurav.Kumbhat@ibm.com>

Author: gkumbhat

vllm_detector_adapter/detector_dispatcher.py

@@ -9,6 +9,17 @@
 def detector_dispatcher(types=None):
     """Decorator to dispatch to processing function based on type of the detector.
 
+    This decorator allows us to reuse same function name for different types of detectors.
+    For example, the same function name can be used for text chat and context analysis
+    detectors. These decorated functions for these detectors will have different arguments
+    and implementation but they share the same function name.
+
+    NOTE: At the time of invoking these decorated function, the user needs to specify the type
+    of the detector using fn_type argument.
+
+    CAUTION: Since this decorator allow re-use of the name, one must take care of using different types
+    for testing different functions.
+
     Args:
         types (list): Type of the detector this function applies to.
         args: Positional arguments passed to the processing function.
@@ -17,11 +28,12 @@ def detector_dispatcher(types=None):
     Examples
     --------
 
-    @detector_dispatcher(types["foo"])
+    @detector_dispatcher(types=["foo"])
     def f(x):
         pass
 
-    @detector_dispatcher(types["bar"])
+    # Decorator can take multiple types as well
+    @detector_dispatcher(types=["bar", "baz"])
     def f(x):
         pass
 

vllm_detector_adapter/generative_detectors/base.py

@@ -82,6 +82,8 @@ def apply_output_template(
 
     ##### Chat request processing functions ####################################
 
+    # Usage of detector_dispatcher allows same function name to be called for different types of
+    # detectors with different arguments and implementation.
     @detector_dispatcher(types=[DetectorType.TEXT_CHAT])
     def apply_task_template(
         self, request: ChatDetectionRequest

vllm_detector_adapter/generative_detectors/granite_guardian.py

@@ -63,6 +63,8 @@ def __preprocess(
 
         return request
 
+    # Decorating this function to make it cleaner for future iterations of this function
+    # to support other types of detectors
     @detector_dispatcher(types=[DetectorType.TEXT_CONTEXT_DOC])
     def _request_to_chat_completion_request(
         self, request: ContextAnalysisRequest, model_name: str
@@ -142,6 +144,8 @@ def _request_to_chat_completion_request(
 
     ##### General request / response processing functions ##################
 
+    # Used detector_dispatcher decorator to allow for the same function to be called
+    # for different types of detectors with different request types etc.
     @detector_dispatcher(types=[DetectorType.TEXT_CHAT])
     def preprocess_request(
         self, request: ChatDetectionRequest