✨ save parameters

Signed-off-by: peter szemraj <[email protected]>

app.py

@@ -182,7 +182,8 @@ def proc_submission(
     html += ""
 
     # save to file
-    saved_file = saves_summary(_summaries)
+    settings["model_name"] = model_name
+    saved_file = saves_summary(_summaries, **settings)
 
     return html, sum_text_out, scores_out, saved_file
 

utils.py

@@ -88,19 +88,17 @@ def load_example_filenames(example_path: str or Path):
     return examples
 
 
-def saves_summary(summarize_output, outpath: str or Path = None, add_signature=True):
+def saves_summary(
+    summarize_output, outpath: str or Path = None, add_signature=True, **kwargs
+):
     """
-
     saves_summary - save the summary generated from summarize_via_tokenbatches() to a text file
 
-            _summaries = summarize_via_tokenbatches(
-              text,
-              batch_length=token_batch_length,
-              batch_stride=batch_stride,
-              **settings,
-          )
+    summarize_output: output from summarize_via_tokenbatches()
+    outpath: path to the output file
+    add_signature: whether to add a signature to the output file
+    kwargs: additional keyword arguments to include in the output file
     """
-
     outpath = (
         Path.cwd() / f"document_summary_{get_timestamp()}.txt"
         if outpath is None
@@ -114,19 +112,26 @@ def saves_summary(summarize_output, outpath: str or Path = None, add_signature=T
     with open(
         outpath,
         "w",
+        encoding="utf-8",
     ) as fo:
-        if add_signature:
-            fo.write(
-                "Generated with the Document Summarization space :) https://hf.co/spaces/pszemraj/document-summarization\n\n"
-            )
         fo.writelines(full_summary)
+        fo.write("\n\n")
+        if add_signature:
+            fo.write("\n\n---\n\n")
+            fo.write("Generated with the Document Summarization space :)\n\n")
+            fo.write("https://hf.co/spaces/pszemraj/document-summarization\n\n")
     with open(
         outpath,
         "a",
     ) as fo:
         fo.write("\n" * 3)
-        fo.write(f"\n\nSection Scores:\n")
+        fo.write(f"## Section Scores:\n\n")
         fo.writelines(scores_text)
-        fo.write("\n\n---\n")
-
+        fo.write("\n\n")
+        fo.write(f"Date: {get_timestamp()}\n\n")
+        if kwargs:
+            fo.write("---\n\n")
+            fo.write("Parameters:\n\n")
+            for key, value in kwargs.items():
+                fo.write(f"{key}: {value}\n")
     return outpath