Added ability to include comments on the saved trace

src/architectures.py

@@ -262,7 +262,7 @@ class Architecture:
             Architecture.save_repo.push_to_hub()
 
     def attempt_request_and_trace_save(self, request: ArchitectureRequest, trace: ArchitectureTrace,
-                                       trace_tags: List[str] = None) -> None:
+                                       trace_tags: List[str] = None, trace_comment: str = None) -> None:
         """
         Attempt to save a request and trace pair to a json store on huggingface datasets
         Catch any errors and simply print as non-fatal to functional flow
@@ -270,6 +270,8 @@ class Architecture:
         try:
             if trace_tags is None:
                 trace_tags = []
+            if trace_comment is None:
+                trace_comment = ""
             save_dict = {
                 'architecture': self.name,
                 'request': request.as_dict(),
@@ -294,7 +296,7 @@ class Architecture:
         self.exception_text = exception_text
         self.no_response_text = no_response_text
 
-    def __call__(self, request: ArchitectureRequest, trace_tags: List[str] = None) -> ArchitectureTrace:
+    def __call__(self, request: ArchitectureRequest, trace_tags: List[str] = None, trace_comment: str = None) -> ArchitectureTrace:
         """
         The main entry point to call the pipeline. Passes the request through each pipeline step
         in sequence, allowing them to amend the request or early exit the processing. Also captures
@@ -319,7 +321,7 @@ class Architecture:
                 trace.steps[-1].exception = err
                 traceback.print_exc()
                 break
-        self.attempt_request_and_trace_save(request, trace, trace_tags)
+        self.attempt_request_and_trace_save(request, trace, trace_tags, trace_comment)
         return trace